A JSON API exposes resources through HTTP endpoints. Keep response formats predictable and validate incoming data before using it.
Error responses should be useful but safe. Do not expose stack traces, database credentials, internal file paths, or other sensitive information to clients.
Deep dive
Consistent API responses
Define a response convention early. For example, successful collection responses may contain data and pagination metadata, while errors may contain an error code and human-readable message.
Content type
For JSON APIs, send an appropriate Content-Type such as application/json and ensure the response is valid JSON.
ADVERTISEMENT