Overview

  1. Introduction: Brief overview of the API's purpose.

  2. Authentication: Details on how clients should authenticate requests.

  3. Versioning: How different versions of the API are managed.

  4. HTTP Methods: Clear guidelines on which HTTP method to use for which type of operation.

  5. Endpoints: Explanation of resource naming conventions, path structures, etc.

  6. Query Params: Usage of common query parameters like sorting, filtering, limiting, etc.

  7. Request & Response Format: Standardizing request payloads and response structures.

  8. Error Handling: How errors are communicated to the client.

  9. Status Codes: Explanation of HTTP status codes used.

  10. Database Relationship Types: Clarifying one-to-one, one-to-many, and many-to-many relationships and how they're handled.

  11. Examples: Providing concrete examples of typical API requests and responses.


API Overview (with query params)

Query Params section is not reflective of our actual query params (this table is from during the API schema redesign)

Last updated