Example of REST API documentation (Based on Twitter, 2018)

rest-api-doc-example.md

/api/v1/work/status

Description of what the REST endpoint does.

Methods

• GET

Resource URL

https://your-domain.net/api/v1/work/status

Resource Information

Response formats	JSON
Requires authentication?	No
Rate limited?	No

Parameters

Name	Required	Description	Default Value	Example
User ID	Yes	Must be a valid id	NULL	1

Example Request

  GET https://your-domain.net/api/v1/work/status?user-id=2

Example Response

{
  "message" : "You're so good at being you!"
}