Skip to content

Instantly share code, notes, and snippets.

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


Description of what the REST endpoint does.


  • GET

Resource URL

Resource Information

Response formats JSON
Requires authentication? No
Rate limited? No


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

Example Request


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