fastapi-docs
Installation
SKILL.md
FastAPI Skill
- Version: FastAPI 0.115+ (latest)
- Documentation: https://fastapi.tiangolo.com/
- Learn: https://fastapi.tiangolo.com/learn/
- Reference: https://fastapi.tiangolo.com/reference/
Quick Reference
| Topic | File |
|---|---|
| Getting Started (Python types, async/await, environment variables, virtual environments, first steps, path parameters, query parameters, request body) | getting-started.md |
| Tutorial Core (Query/path string & numeric validations, query/body parameter models, body fields, nested models, request examples, extra data types, cookie/header parameters, response model, extra models, response status code, form data, form models, request files, forms and files, handling errors, path operation configuration, JSON encoder, body updates) | tutorial-core.md |
| Tutorial: Dependencies & Security (Dependencies, classes as dependencies, sub-dependencies, decorator dependencies, global dependencies, yield dependencies, security first steps, get current user, OAuth2 with JWT, middleware, CORS, SQL databases, bigger applications with APIRouter, stream JSON lines, server-sent events, background tasks, metadata and docs URLs, frontend, static files, testing, debugging) | tutorial-deps-security.md |
| Advanced User Guide (Stream data, path operation advanced config, additional status codes, return response directly, custom responses: HTML/Stream/File, additional OpenAPI responses, response cookies, response headers, response change status code, advanced dependencies, OAuth2 scopes, HTTP Basic Auth, using request directly, dataclasses, advanced middleware, sub-applications/mounts, behind a proxy, templates, WebSockets, lifespan events, testing WebSockets, testing events, testing dependency overrides, async tests, settings & env vars, OpenAPI callbacks, OpenAPI webhooks, WSGI inclusion, generating SDKs, advanced Python types, JSON with bytes as Base64, strict content-type checking, FastAPI CLI, editor support) | advanced.md |
| Deployment (FastAPI versions, FastAPI Cloud, HTTPS, run server manually, deployment concepts, cloud providers, server workers with Uvicorn, Docker containers) | deployment.md |
| How To — Recipes (General recipes, Pydantic v1→v2 migration, GraphQL, custom request/APIRoute class, conditional OpenAPI, extending OpenAPI, separate input/output schemas, custom docs UI assets, configure Swagger UI, testing a database, old 403 auth error codes) | how-to.md |
| API Reference (FastAPI class, request parameters: Path/Query/Header/Cookie/Body/Form/File, status codes, UploadFile, exceptions: HTTPException/WebSocketException, Depends/Security, APIRouter, BackgroundTasks, Request class, WebSockets, HTTPConnection, Response class, custom response classes, middleware, OpenAPI docs & models, security tools, jsonable_encoder, StaticFiles, Jinja2Templates, TestClient) | reference.md |
| About & Resources (Features: FastAPI/Starlette/Pydantic features; Alternatives & inspiration: Django, Flask, NestJS, Marshmallow, APIStar; History, design & future; Benchmarks: Uvicorn/Starlette/FastAPI hierarchy; Repository management: owner & team; Release notes: all versions 0.1.19–0.139.2+; Help: newsletter, social, GitHub discussions, Discord; Contributing guidelines; Translations: LLM-assisted with native review; Full Stack Template: FastAPI+SQLModel+React+PostgreSQL+Docker; External links: top GitHub repos; FastAPI People: creator, team, experts, contributors, sponsors; Newsletter) | about-resources.md |