Add summary and description to a FastAPI endpoint for Swagger UI
This tests FastAPI path operation decorator configuration. Pass summary and description to @app.get, or use function docstring for description. A red flag is setting metadata inside the function body or confusing docs with Pydantic Field descriptions.
This tests FastAPI path operation decorator configuration and OpenAPI metadata. Answer with two approaches: pass summary and description directly to the decorator like @app.get, or use the function docstring which FastAPI auto-extracts as the description. Note these parameters belong on the decorator, not the function body. Red flags: confusing endpoint metadata with Pydantic Field descriptions, setting docs via return values, or manually editing the OpenAPI schema instead of using the decorator parameters.
Read the original → fastapi.tiangolo.com
- #fastapi
- #swagger-ui
- #openapi
- #python
- #documentation
Get five bites like this every day.
Tezvyn delivers a daily feed of 60-second tech bites with quizzes to lock in what you learn.