Skip to content

Instantly share code, notes, and snippets.

@NikolayS

NikolayS/HowToTroubleshootAPI.md

Last active August 6, 2017 05:52
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save NikolayS/739284db0233c820e80c08aad286bfb8 to your computer and use it in GitHub Desktop.
Save NikolayS/739284db0233c820e80c08aad286bfb8 to your computer and use it in GitHub Desktop.
Download ZIP
API Troubleshooting: How to Report a Bug
Raw
HowToTroubleshootAPI.md

If you have any issue with REST API, please provide:

1) Full HTTP request:

  • HTTP method (GET, POST, ..)
  • Protocol+hostname+port (important! was it dev, staging, or production? Example: https://apiserver:4321
  • URI (examples: /people?id=eq.1, /rpc/some_function?user_id=eq.1)
  • All request headers
  • Payload (in case of POST, or PUT, or PATCH, usually in JSON format)

2) The actual response from the server:

  • HTTP Status code (for example, 200 OK or 400 Bad Request)
  • All response headers
  • Response body (usually in JSON format)

3) Your comments:

please add as many details as possible: what you expected, what you see, what is wrong.

N.B. If you use Postman, it is easy to provide all request details – there is a special link 'Code' which allows you to quickly generate code for your request. Usually, the most convenient formats are: "HTTP" and "cURL". As for response, it is a bit more tricky: you need to collect all three items manually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment