Development › API Docs (Swagger)
Swagger / OpenAPI (API Gateway)
Interactive API docs are powered by Scramble (OpenAPI 3 + Stoplight Elements UI).
#URLs
| URL | What |
|---|---|
| http://localhost:8000/docs/api | Swagger-style UI |
| http://localhost:8000/docs/api.json | OpenAPI JSON |
#Auth in the UI
POST /api/auth/login(Try it) → copydata.token- Click Authorize → paste token as Bearer
- Call protected endpoints (
/api/auth/me,/api/v1/...)
#What is documented
Routes under the api path prefix, including:
- Auth / Users (local gateway modules)
- Health endpoints (if under documented paths)
- Gateway-proxied microservice routes when registered
#Docker
Rebuild the API image after installing Scramble so the container has the package:
docker compose up -d --build appThen open http://localhost:8000/docs/api