Create API documentation with OpenAPI / Swagger

Define an OpenAPI specification for the main endpoints and mount a Swagger UI or Redoc viewer at a dedicated route. Keep models in sync with the actual response shapes and include example payloads for key operations.

First, examine the existing API endpoints in the codebase to understand the request/response shapes. Use a tool like Swagger Editor or Redoc to draft the OpenAPI spec, ensuring it matches the actual implementation. Then, integrate a viewer (Swagger UI or Redoc) at a dedicated route, likely in the server setup or routing files. Verify by running the application and checking the documentation route.

索引モデルが issue の本文から書いたものです。