Aller au contenu principal

API overview

Principles

  • JSON-first endpoints
  • Authentication and authorization
  • Pagination and filtering
  • Caching headers (ETag / Last-Modified) when relevant

Suggested documentation format per endpoint

For each endpoint, describe:

  • Method + path
  • Query params
  • Response schema (example)
  • Error cases
  • Caching behavior