api v1 error handling
Each API response contains a success
(boolean) field. When success
is false
, the error
(string) field with the error description is also included.
Example success response:
{ "success": true }
Example error response:
{ "success": false, "error": "Missing data" }
In addition, various HTTP errors may occur, e.g. 404
if the endpoint does not exist or 500
if API is unavailable due to some backend malfunction. If the status is not 200
, the contents of response body is unpredictable and should be ignored.
No Comments