Field note
What it does
FastAPI fastapi/fastapi FastAPI FastAPI On this page Sponsors Keystone Sponsor Gold Sponsors Silver Sponsors Opinions FastAPI Conf FastAPI mini documentary Typer , the FastAPI of CLIs Requirements Installation Example Create it Run it Check it Interactive API docs Alternative API docs Example upgrade Interactive API docs upgrade Alternative API docs upgrade Recap Deploy your app (optional) About FastAPI Cloud Deploy to other cloud providers Performance Dependencies standard Dependencies Without standard Dependencies Without fastapi-cloud-cli Additional Optional Dependencies License Features Learn Python Types Intro Concurrency and async / await Tutorial - User Guide First Steps Path Parameters Query Parameters Request Body Query Parameters and String Validations Path Parameters and Numeric Validations Query Parameter Models Body - Multiple Parameters Body - Fields Body - Nested Models Declare Request Example Data Extra Data Types Cookie Parameters Header Parameters Cookie Parameter Models Header Parameter Models Response Model - Return Type Extra Models Response Status Code Form Data Form Models Request Files Request Forms and Files Handling Errors Path Operation Configuration JSON Compatible Encoder Body - Updates Dependencies Classes as Dependencies Sub-dependencies Dependencies in path operation decorators Global Dependencies Dependencies with yield Security Security - First Steps Get Current User Simple OAuth2 with Password and Bearer OAuth2 with Password (and hashing), Bearer with JWT tokens Middleware CORS (Cross-Origin Resource Sharing) SQL (Relational) Databases Bigger Applications - Multiple Files Stream JSON Lines Server-Sent Events (SSE) Background Tasks Metadata and Docs URLs Frontend Static Files Testing Debugging Advanced User Guide Stream Data Path Operation Advanced Configuration Additional Status Codes Return a Response Directly Custom Response - HTML, Stream, File, others Additional Responses in OpenAPI Response Cookies Response Headers Response - Change Status Code Advanced Dependencies Advanced Security OAuth2 scopes HTTP Basic Auth Using the Request Directly Using Dataclasses Advanced Middleware Sub Applications - Mounts Behind a Proxy Templates WebSockets Lifespan Events Testing WebSockets Testing Events: lifespan and startup - shutdown Testing Dependencies with Overrides Async Tests Settings and Environment Variables OpenAPI Callbacks OpenAPI Webhooks Including WSGI - Flask, Django, others Generating SDKs Advanced Python Types JSON with Bytes as Base64 Strict Content-Type Checking FastAPI CLI Editor Support Deployment About FastAPI versions FastAPI Cloud About HTTPS Run a Server Manually Deployments Concepts Deploy FastAPI on Cloud Providers Server Workers - Uvicorn with Workers FastAPI in Containers - Docker How To - Recipes General - How To - Recipes Migrate from Pydantic v1 to Pydantic v2 GraphQL Custom Request and APIRoute class Conditional OpenAPI Extending OpenAPI Separate OpenAPI Schemas for Input and Output or Not Custom Docs UI Static Assets (Self-Hosting) Configure Swagger UI Testing a Database Use Old 403 Authentication Error Status Codes Reference FastAPI class Request Paramet FastAPI fastapi/fastapi FastAPI Features Learn Python Types Intro Concurrency and async / await Tutorial - User Guide First Steps Path Parameters Query Parameters Request Body Query Parameters and String Validations Path Parameters and Numeric Validations Query Parameter Models Body - Multiple Parameters Body - Fields Body - Nested Models Declare Request Example Data Extra Data Types Cookie Parameters Header Parameters Cookie Parameter Models Header Parameter Models Response Model - Return Type Extra Models Response Status Code Form Data Form Models Request Files Request Forms and Files Handling Errors Path Operation Configuration JSON Compatible Encoder Body - Updates Dependencies Classes as Dependencies Sub-dependencies Dependencies in path operation decorators Global Dependencies Dependencies with yield Security Security - First Steps Get Current User Simple OAuth2 with Password and Bearer OAuth2 with Password (and hashing), Bearer with JWT tokens Middleware CORS (Cross-Origin Resource Sharing) SQL (Relational) Databases Bigger Applications - Multiple Files Stream JSON Lines Server-Sent Events (SSE) Background Tasks Metadata and Docs URLs Frontend Static Files Testing Debugging Advanced User Guide Stream Data Path Operation Advanced Configuration Additional Status Codes Return a Response Directly Custom Response - HTML, Stream, File, others Additional Responses in OpenAPI Response Cookies Response Headers Response - Change Status Code Advanced Dependencies Advanced Security OAuth2 scopes HTTP Basic Auth Using the Request Directly Using Dataclasses Advanced Middleware Sub Applications - Mounts Behind a Proxy Templates WebSockets Lifespan Events Testing WebSockets Testing Events: lifespan and startup - shutdown Testing Dependencies with Overrides Async Tests Settings and Environment Variables OpenAPI Callbacks OpenAPI Webhooks Including WSGI - Flask, Django, others Generating SDKs Advanced Python Types JSON with Bytes as Base64 Strict Content-Type Checking FastAPI CLI Editor Support Deployment About FastAPI versions FastAPI Cloud About HTTPS Run a Server Manually Deployments Concepts Deploy FastAPI on Cloud Providers Server Workers - Uvicorn with Workers FastAPI in Containers - Docker How To - Recipes General - How To - Recipes Migrate from Pydantic v1 to Pydantic v2 GraphQL Custom Request and APIRoute class Conditional OpenAPI Extending OpenAPI Separate OpenAPI Schemas for Input and Output or Not Custom Docs UI Static Assets (Self-Hosting) Configure Swagger UI Testing a Database Use Old 403 Authentication Error Status Codes Reference FastAPI class Request Parameters Request Parameters On this page Query Path Body Cookie Header Form File Status Codes UploadFile class Exceptions - HTTPException and WebSocketException Dependencies - Depends() and Security() APIRouter class Background Tasks - BackgroundTasks Request class WebSockets HTTPConnection class Response class Custom Response Classes - File, HTML, Redirect, Streaming, etc. Server-Sent Events - EventSourceResponse and ServerSentEvent Middleware OpenAPI OpenAPI docs OpenAPI models Security Tools Encoders - jsonable_encoder Static Files - StaticFiles Templating - Jinja2Templates Test Client - TestClient Resources FastAPI People Help Contributing Translations Full Stack FastAPI Template External Links FastAPI and friends newsletter About Alternatives, Inspiration and Comparisons History, Design and Future Benchmarks Repository Management Release Notes On this page Query Path Body Cookie Header Form File FastAPI Reference Request Parameters ¶ Here's the reference information for the request parameters. These are the special functions that you can put in path operation function parameters or dependency functions with Annotated to get data from the request. It includ Sections: Status Codes ¶ | Example ¶ | fastapi.status ¶ | HTTP_100_CONTINUE module-attribute ¶ | HTTP_101_SWITCHING_PROTOCOLS module-attribute ¶ | HTTP_102_PROCESSING module-attribute ¶ | HTTP_103_EARLY_HINTS module-attribute ¶ | HTTP_200_OK module-attribute ¶ | HTTP_201_CREATED module-attribute ¶ | HTTP_202_ACCEPTED module-attribute ¶ | HTTP_203_NON_AUTHORITATIVE_INFORMATION module-attribute ¶ | HTTP_204_NO_CONTENT module-attribute ¶ | HTTP_205_RESET_CONTENT module-attribute ¶ | HTTP_206_PARTIAL_CONTENT module-attribute ¶ | HTTP_207_MULTI_STATUS module-attribute ¶ | HTTP_208_ALREADY_REPORTED module-attribute ¶ | HTTP_226_IM_USED module-attribute ¶ | HTTP_300_MULTIPLE_CHOICES module-attribute ¶ | HTTP_301_MOVED_PERMANENTLY module-attribute ¶ | HTTP_302_FOUND module-attribute ¶ | HTTP_303_SEE_OTHER module-attribute ¶ | HTTP_304_NOT_MODIFIED module-attribute ¶ | HTTP_305_USE_PROXY module-attribute ¶ | HTTP_306_RES
Capabilities
Available capabilities
Tags
Tags
No tags filed yet.
Ways to use it
Ways to use it
No integrations filed yet.