Skip to content

Instantly share code, notes, and snippets.

@fadziljusri
Created November 26, 2019 03:38
Show Gist options
  • Save fadziljusri/34de0ed4505e76c3e8e434609c402eba to your computer and use it in GitHub Desktop.
Save fadziljusri/34de0ed4505e76c3e8e434609c402eba to your computer and use it in GitHub Desktop.
API Reference template

API Reference

Get API_TOKEN

API Description 1

Endpoint: https://some.api.com/1
Method: GET
headers: {"Authorization": "access_token API_TOKEN"}

API Description 2

Endpoint: https://some.api.com/2
Method: POST
headers: {"Authorization": "access_token API_TOKEN"}
params:-
{
  "data": {
     ... 
  }
}
Field Description Type
data Each parent config required, object
Field (data) Description Type
some_field some_field desc optional, string
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment