Skip to content

API Documentation

API documentation is rendered by FastAPI on /docs and /redoc paths using OpenAPI format.

AsyncAPI documentation is rendered using the AsyncAPI react components. It is available on /asyncapi path.

API versioning

Versioning an API at resource level provides a much more flexible approach than versioning the whole API.

The example books domain provides 2 endpoints to demonstrate this approach

  • /api/books/v1 (POST)
  • /api/books/v2 (POST)

Media type versioning

An improvement could be moving to media type versioning