Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Example of REST API documentation (Based on Twitter, 2018)

/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!"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.