API Documentation with Redocly

This project uses Redocly to generate interactive API documentation from the OpenAPI specification.

Viewing the API Documentation

The API documentation is available at the following locations:

• In the documentation site: Navigate to the "API Reference" section and click on "API Documentation"
• Directly from the API: Visit /docs when the API is running
• Redocly standalone page: Available at /redoc when the API is running

Generating the API Documentation

The API documentation is generated from the OpenAPI specification, which is automatically created by FastAPI. To update the documentation:

1. Make sure the API is running:

docker compose up -d api

1. Export the OpenAPI specification:

python scripts/export_openapi.py

1. Build the Redocly documentation:

   ./scripts/build_redoc.sh
   

Alternatively, you can use the redoc service in Docker Compose:

docker compose up redoc

The OpenAPI specification is the source of truth for the generated docs.