api endpoints documentation template

API-endpoints.md

Endpoints

<Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple).>

• /v1/endpoint-1
  • GET • PATCH
• /v1/endpoint-2
  • POST • DELETE

GET /v1/endpoint-1

Header Params

Name	Description
x-id-token*	JWT of the user

Query Params

Name	Description
x-id-token*	JWT of the user

Payload

<If making a post request, what should the body payload look like? URL Params rules apply here too.>

Success Response

• Code: 200

Name	Type	Description
message	string	Message of success

• Example

{
    "message": "booyah!"
}

Error Response:

• Code: 401 - UNAUTHORIZED

{
    "error": "say whaaat?"
}

OR

• Code: 422 - UNPROCESSABLE ENTRY

{
    "error" : "Email Invalid"
}

• Sample Call:

  <Just a sample call to your endpoint in a runnable format ($.ajax call or a curl request) - this makes life easier and more predictable.>

  curl -X GET ...

• Notes:

  <This is where all uncertainties, commentary, discussion etc. can go. I recommend timestamping and identifying oneself when leaving comments here.>