Movies Database API documentation version v1

http://127.0.0.1:3000

/api.raml

get

get

get /api.raml

/movies

get post

get

get /movies

post

post /movies

post /movies

Body

Media type: application/json

Type: string

Example:

{
  "id": 3,
  "name": "The World's End",
  "year": 2013
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{
  "id": 3,
  "name": "The World's End",
  "year": 2013
}

HTTP status code 409

Body

Media type: application/json

Type: object

Example:

{
  "error": "id exists"
}

get delete

get

get /movies/:id

delete

delete /movies/:id

get /movies/:id

URI Parameters

  • id: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "name": "Shaun of the Dead",
  "year": 2004
}

HTTP status code 404

Body

Media type: application/json

Type: object

Example:

{
  "error": "movie not found"
}

delete /movies/:id

URI Parameters

  • id: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "ok": true
}

HTTP status code 404

Body

Media type: application/json

Type: object

Example:

{
  "error": "movie not found"
}