| title | OpenAPI & Swagger |
|---|---|
| section | api |
| sidebar | true |
| description | Auto-generated API schema from FastAPI. |
The worker is built with FastAPI, which auto-generates an OpenAPI 3 document from route signatures, Pydantic models, and docstrings.
| Live URL (when server is running) | Description |
|---|---|
/openapi.json |
Machine-readable OpenAPI schema |
/docs |
Swagger UI — try endpoints in the browser |
/redoc |
ReDoc — readable reference |
| Layer | Role |
|---|---|
| Guides (this site) | Product narrative — how storage, auth, and tags work |
| API pages (this site) | Curated human reference with cURL, Stripe-style |
| OpenAPI / Swagger | Always-in-sync contract from code — import into Postman, generate clients |
Security schemes (BearerAuth, X-User-Id) are declared in the OpenAPI schema so Swagger UI shows the lock icon and “Authorize” dialog.
- Start the worker.
- Download
http://localhost:3001/openapi.json. - Postman → Import → Link or file.
Or use the ready-made collection under [examples/postman/]({{ '/examples/' | relative_url }}).