Retroku REST API

retroku-api.md

Retroku API

Retroku API is a simple REST API allowing consumers to view different ways of animating a retrospective.

A retrospective is composed by 5 steps, by using Retroku, user can designate an animation for each step:

• Opening
• Collecting data
• Generating ideas
• Deciding actions
• Closing

List of endpoints

GET /retros

For home screen. The GET request will all the available animations grouped by their type.

Response 200

{
    "openings": [],
    "collectings": [],
    "generatings": [],
    "decidings": [],
    "closings": []
}

GET /anims/{anim_id}

For detailed animation screen. The GET request will return an Animation object.

Response 200

{
    "id": "1",
    "name": "Mad Sad Glad",
    "summary": "",
    "description": "",
    "material": "",
    "duration": 60,
    "author": "",
    "source": "",
    "img": "",
    "published_at": "2015-08-05T08:40:51.620Z"
}

Model

Object Animation

Properties

• id | String : ID of the animation
• name | String : name of the animation
• summary | String : summary, short description of the animation
• description | String : full description of the animation
• material | String: TBD
• duration | int : duration of the animation
• author | String : name of the animation inventor
• source | url : url of the source if exists
• img | url : image url for the retro

Nice work!

Counter proposition:

GET /{anim_type}/{anim_id}

{
    "id": "1",
    "name": "Mad Sad Glad",
    "summary": "",
    "description": "",
    "material": "",
    "duration": 60,
    "author": {
        "fullName": "Blah blah"
    },
    "source": "",
    "image": {
        "name": "blah blah",
        "url": "//foo.com/bar.png"
    },
    "publishedAt": "2015-08-05T08:40:51.620Z"
}

Also, please note the camelCase notation. I know it's an eternal debate but I'd stick with the Google JSON Style Guide.