Documenting your REST API

user.md

Show one user

• URL

  /users/:id

• Method:

  GET

• URL Params

  Required:

  id=[integer]

• Data Params

  None

• Success Response:

  • Code: 200
    Content: { id : 12, name : "Michael Bloom" }

• Error Response:

  • Code: 404 NOT FOUND
    Content: { error : "User doesn't exist" }

---

Show all users

• URL

  /users

• Method:

  GET

• URL Params

None

• Data Params

  None

• Success Response:

  • Code: 200
    Content: [{ id : 12, name : "Michael Bloom" }, ...]

• Error Response:

  None

---

Create one user

• URL

  /users

• Method:

  POST

• URL Params

None

• Data Params

  JSON: { name : "John Doe" }

• Success Response:

  • Code: 201
    Content: { id: 13, name : "John Doe" }

• Error Response:

  None

---

Modify one user

• URL

  /users/:id

• Method:

  PUT

• URL Params

  Required:

  id=[integer]

• Data Params

  JSON: { name : "Jane Doe" }

• Success Response:

  • Code: 200
    Content: { id: 13, name : "Jane Doe" }

• Error Response:

  • Code: 404 NOT FOUND
    Content: { error : "User doesn't exist" }

---

Delete one user

• URL

  /users/:id

• Method:

  DELETE

• URL Params

  Required:

  id=[integer]

• Data Params

  None

• Success Response:

  • Code: 204
    No Content

• Error Response:

  • Code: 404 NOT FOUND
    Content: { error : "User doesn't exist" }