| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623 |
- Metadata-Version: 2.4
- Name: fastapi
- Version: 0.135.3
- Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
- Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
- License-Expression: MIT
- License-File: LICENSE
- Classifier: Intended Audience :: Information Technology
- Classifier: Intended Audience :: System Administrators
- Classifier: Operating System :: OS Independent
- Classifier: Programming Language :: Python :: 3
- Classifier: Programming Language :: Python
- Classifier: Topic :: Internet
- Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
- Classifier: Topic :: Software Development :: Libraries
- Classifier: Topic :: Software Development
- Classifier: Typing :: Typed
- Classifier: Development Status :: 4 - Beta
- Classifier: Environment :: Web Environment
- Classifier: Framework :: AsyncIO
- Classifier: Framework :: FastAPI
- Classifier: Framework :: Pydantic
- Classifier: Framework :: Pydantic :: 2
- Classifier: Intended Audience :: Developers
- Classifier: Programming Language :: Python :: 3 :: Only
- Classifier: Programming Language :: Python :: 3.10
- Classifier: Programming Language :: Python :: 3.11
- Classifier: Programming Language :: Python :: 3.12
- Classifier: Programming Language :: Python :: 3.13
- Classifier: Programming Language :: Python :: 3.14
- Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
- Classifier: Topic :: Internet :: WWW/HTTP
- Project-URL: Homepage, https://github.com/fastapi/fastapi
- Project-URL: Documentation, https://fastapi.tiangolo.com/
- Project-URL: Repository, https://github.com/fastapi/fastapi
- Project-URL: Issues, https://github.com/fastapi/fastapi/issues
- Project-URL: Changelog, https://fastapi.tiangolo.com/release-notes/
- Requires-Python: >=3.10
- Requires-Dist: starlette>=0.46.0
- Requires-Dist: pydantic>=2.9.0
- Requires-Dist: typing-extensions>=4.8.0
- Requires-Dist: typing-inspection>=0.4.2
- Requires-Dist: annotated-doc>=0.0.2
- Provides-Extra: standard
- Requires-Dist: fastapi-cli[standard]>=0.0.8; extra == "standard"
- Requires-Dist: httpx<1.0.0,>=0.23.0; extra == "standard"
- Requires-Dist: jinja2>=3.1.5; extra == "standard"
- Requires-Dist: python-multipart>=0.0.18; extra == "standard"
- Requires-Dist: email-validator>=2.0.0; extra == "standard"
- Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard"
- Requires-Dist: pydantic-settings>=2.0.0; extra == "standard"
- Requires-Dist: pydantic-extra-types>=2.0.0; extra == "standard"
- Provides-Extra: standard-no-fastapi-cloud-cli
- Requires-Dist: fastapi-cli[standard-no-fastapi-cloud-cli]>=0.0.8; extra == "standard-no-fastapi-cloud-cli"
- Requires-Dist: httpx<1.0.0,>=0.23.0; extra == "standard-no-fastapi-cloud-cli"
- Requires-Dist: jinja2>=3.1.5; extra == "standard-no-fastapi-cloud-cli"
- Requires-Dist: python-multipart>=0.0.18; extra == "standard-no-fastapi-cloud-cli"
- Requires-Dist: email-validator>=2.0.0; extra == "standard-no-fastapi-cloud-cli"
- Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard-no-fastapi-cloud-cli"
- Requires-Dist: pydantic-settings>=2.0.0; extra == "standard-no-fastapi-cloud-cli"
- Requires-Dist: pydantic-extra-types>=2.0.0; extra == "standard-no-fastapi-cloud-cli"
- Provides-Extra: all
- Requires-Dist: fastapi-cli[standard]>=0.0.8; extra == "all"
- Requires-Dist: httpx<1.0.0,>=0.23.0; extra == "all"
- Requires-Dist: jinja2>=3.1.5; extra == "all"
- Requires-Dist: python-multipart>=0.0.18; extra == "all"
- Requires-Dist: itsdangerous>=1.1.0; extra == "all"
- Requires-Dist: pyyaml>=5.3.1; extra == "all"
- Requires-Dist: email-validator>=2.0.0; extra == "all"
- Requires-Dist: uvicorn[standard]>=0.12.0; extra == "all"
- Requires-Dist: pydantic-settings>=2.0.0; extra == "all"
- Requires-Dist: pydantic-extra-types>=2.0.0; extra == "all"
- Description-Content-Type: text/markdown
- <p align="center">
- <a href="https://fastapi.tiangolo.com"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI"></a>
- </p>
- <p align="center">
- <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
- </p>
- <p align="center">
- <a href="https://github.com/fastapi/fastapi/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster">
- <img src="https://github.com/fastapi/fastapi/actions/workflows/test.yml/badge.svg?event=push&branch=master" alt="Test">
- </a>
- <a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/fastapi">
- <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/fastapi.svg" alt="Coverage">
- </a>
- <a href="https://pypi.org/project/fastapi">
- <img src="https://img.shields.io/pypi/v/fastapi?color=%2334D058&label=pypi%20package" alt="Package version">
- </a>
- <a href="https://pypi.org/project/fastapi">
- <img src="https://img.shields.io/pypi/pyversions/fastapi.svg?color=%2334D058" alt="Supported Python versions">
- </a>
- </p>
- ---
- **Documentation**: [https://fastapi.tiangolo.com](https://fastapi.tiangolo.com)
- **Source Code**: [https://github.com/fastapi/fastapi](https://github.com/fastapi/fastapi)
- ---
- FastAPI is a modern, fast (high-performance), web framework for building APIs with Python based on standard Python type hints.
- The key features are:
- * **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance).
- * **Fast to code**: Increase the speed to develop features by about 200% to 300%. *
- * **Fewer bugs**: Reduce about 40% of human (developer) induced errors. *
- * **Intuitive**: Great editor support. <dfn title="also known as auto-complete, autocompletion, IntelliSense">Completion</dfn> everywhere. Less time debugging.
- * **Easy**: Designed to be easy to use and learn. Less time reading docs.
- * **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.
- * **Robust**: Get production-ready code. With automatic interactive documentation.
- * **Standards-based**: Based on (and fully compatible with) the open standards for APIs: [OpenAPI](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) and [JSON Schema](https://json-schema.org/).
- <small>* estimation based on tests conducted by an internal development team, building production applications.</small>
- ## Sponsors
- <!-- sponsors -->
- ### Keystone Sponsor
- <a href="https://fastapicloud.com" target="_blank" title="FastAPI Cloud. By the same team behind FastAPI. You code. We Cloud."><img src="https://fastapi.tiangolo.com/img/sponsors/fastapicloud.png"></a>
- ### Gold and Silver Sponsors
- <a href="https://blockbee.io?ref=fastapi" target="_blank" title="BlockBee Cryptocurrency Payment Gateway"><img src="https://fastapi.tiangolo.com/img/sponsors/blockbee.png"></a>
- <a href="https://github.com/scalar/scalar/?utm_source=fastapi&utm_medium=website&utm_campaign=main-badge" target="_blank" title="Scalar: Beautiful Open-Source API References from Swagger/OpenAPI files"><img src="https://fastapi.tiangolo.com/img/sponsors/scalar.svg"></a>
- <a href="https://www.propelauth.com/?utm_source=fastapi&utm_campaign=1223&utm_medium=mainbadge" target="_blank" title="Auth, user management and more for your B2B product"><img src="https://fastapi.tiangolo.com/img/sponsors/propelauth.png"></a>
- <a href="https://zuplo.link/fastapi-gh" target="_blank" title="Zuplo: Deploy, Secure, Document, and Monetize your FastAPI"><img src="https://fastapi.tiangolo.com/img/sponsors/zuplo.png"></a>
- <a href="https://liblab.com?utm_source=fastapi" target="_blank" title="liblab - Generate SDKs from FastAPI"><img src="https://fastapi.tiangolo.com/img/sponsors/liblab.png"></a>
- <a href="https://docs.render.com/deploy-fastapi?utm_source=deploydoc&utm_medium=referral&utm_campaign=fastapi" target="_blank" title="Deploy & scale any full-stack web app on Render. Focus on building apps, not infra."><img src="https://fastapi.tiangolo.com/img/sponsors/render.svg"></a>
- <a href="https://www.coderabbit.ai/?utm_source=fastapi&utm_medium=badge&utm_campaign=fastapi" target="_blank" title="Cut Code Review Time & Bugs in Half with CodeRabbit"><img src="https://fastapi.tiangolo.com/img/sponsors/coderabbit.png"></a>
- <a href="https://subtotal.com/?utm_source=fastapi&utm_medium=sponsorship&utm_campaign=open-source" target="_blank" title="The Gold Standard in Retail Account Linking"><img src="https://fastapi.tiangolo.com/img/sponsors/subtotal.svg"></a>
- <a href="https://docs.railway.com/guides/fastapi?utm_medium=integration&utm_source=docs&utm_campaign=fastapi" target="_blank" title="Deploy enterprise applications at startup speed"><img src="https://fastapi.tiangolo.com/img/sponsors/railway.png"></a>
- <a href="https://serpapi.com/?utm_source=fastapi_website" target="_blank" title="SerpApi: Web Search API"><img src="https://fastapi.tiangolo.com/img/sponsors/serpapi.png"></a>
- <a href="https://www.greptile.com/?utm_source=fastapi&utm_medium=sponsorship&utm_campaign=fastapi_sponsor_page" target="_blank" title="Greptile: The AI Code Reviewer"><img src="https://fastapi.tiangolo.com/img/sponsors/greptile.png"></a>
- <a href="https://databento.com/?utm_source=fastapi&utm_medium=sponsor&utm_content=display" target="_blank" title="Pay as you go for market data"><img src="https://fastapi.tiangolo.com/img/sponsors/databento.svg"></a>
- <a href="https://speakeasy.com/editor?utm_source=fastapi+repo&utm_medium=github+sponsorship" target="_blank" title="SDKs for your API | Speakeasy"><img src="https://fastapi.tiangolo.com/img/sponsors/speakeasy.png"></a>
- <a href="https://www.svix.com/" target="_blank" title="Svix - Webhooks as a service"><img src="https://fastapi.tiangolo.com/img/sponsors/svix.svg"></a>
- <a href="https://www.stainlessapi.com/?utm_source=fastapi&utm_medium=referral" target="_blank" title="Stainless | Generate best-in-class SDKs"><img src="https://fastapi.tiangolo.com/img/sponsors/stainless.png"></a>
- <a href="https://www.permit.io/blog/implement-authorization-in-fastapi?utm_source=github&utm_medium=referral&utm_campaign=fastapi" target="_blank" title="Fine-Grained Authorization for FastAPI"><img src="https://fastapi.tiangolo.com/img/sponsors/permit.png"></a>
- <a href="https://www.interviewpal.com/?utm_source=fastapi&utm_medium=open-source&utm_campaign=dev-hiring" target="_blank" title="InterviewPal - AI Interview Coach for Engineers and Devs"><img src="https://fastapi.tiangolo.com/img/sponsors/interviewpal.png"></a>
- <a href="https://dribia.com/en/" target="_blank" title="Dribia - Data Science within your reach"><img src="https://fastapi.tiangolo.com/img/sponsors/dribia.png"></a>
- <!-- /sponsors -->
- [Other sponsors](https://fastapi.tiangolo.com/fastapi-people/#sponsors)
- ## Opinions
- "_[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products._"
- <div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/fastapi/fastapi/pull/26"><small>(ref)</small></a></div>
- ---
- "_We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]_"
- <div style="text-align: right; margin-right: 10%;">Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - <strong>Uber</strong> <a href="https://eng.uber.com/ludwig-v0-2/"><small>(ref)</small></a></div>
- ---
- "_**Netflix** is pleased to announce the open-source release of our **crisis management** orchestration framework: **Dispatch**! [built with **FastAPI**]_"
- <div style="text-align: right; margin-right: 10%;">Kevin Glisson, Marc Vilanova, Forest Monsen - <strong>Netflix</strong> <a href="https://netflixtechblog.com/introducing-dispatch-da4b8a2a8072"><small>(ref)</small></a></div>
- ---
- "_I’m over the moon excited about **FastAPI**. It’s so fun!_"
- <div style="text-align: right; margin-right: 10%;">Brian Okken - <strong>[Python Bytes](https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855) podcast host</strong> <a href="https://x.com/brianokken/status/1112220079972728832"><small>(ref)</small></a></div>
- ---
- "_Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that._"
- <div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong>[Hug](https://github.com/hugapi/hug) creator</strong> <a href="https://news.ycombinator.com/item?id=19455465"><small>(ref)</small></a></div>
- ---
- "_If you're looking to learn one **modern framework** for building REST APIs, check out **FastAPI** [...] It's fast, easy to use and easy to learn [...]_"
- "_We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]_"
- <div style="text-align: right; margin-right: 10%;">Ines Montani - Matthew Honnibal - <strong>[Explosion AI](https://explosion.ai) founders - [spaCy](https://spacy.io) creators</strong> <a href="https://x.com/_inesmontani/status/1144173225322143744"><small>(ref)</small></a> - <a href="https://x.com/honnibal/status/1144031421859655680"><small>(ref)</small></a></div>
- ---
- "_If anyone is looking to build a production Python API, I would highly recommend **FastAPI**. It is **beautifully designed**, **simple to use** and **highly scalable**, it has become a **key component** in our API first development strategy and is driving many automations and services such as our Virtual TAC Engineer._"
- <div style="text-align: right; margin-right: 10%;">Deon Pillsbury - <strong>Cisco</strong> <a href="https://www.linkedin.com/posts/deonpillsbury_cisco-cx-python-activity-6963242628536487936-trAp/"><small>(ref)</small></a></div>
- ---
- ## FastAPI mini documentary
- There's a [FastAPI mini documentary](https://www.youtube.com/watch?v=mpR8ngthqiE) released at the end of 2025, you can watch it online:
- <a href="https://www.youtube.com/watch?v=mpR8ngthqiE"><img src="https://fastapi.tiangolo.com/img/fastapi-documentary.jpg" alt="FastAPI Mini Documentary"></a>
- ## **Typer**, the FastAPI of CLIs
- <a href="https://typer.tiangolo.com"><img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" style="width: 20%;"></a>
- If you are building a <abbr title="Command Line Interface">CLI</abbr> app to be used in the terminal instead of a web API, check out [**Typer**](https://typer.tiangolo.com/).
- **Typer** is FastAPI's little sibling. And it's intended to be the **FastAPI of CLIs**. ⌨️ 🚀
- ## Requirements
- FastAPI stands on the shoulders of giants:
- * [Starlette](https://www.starlette.dev/) for the web parts.
- * [Pydantic](https://docs.pydantic.dev/) for the data parts.
- ## Installation
- Create and activate a [virtual environment](https://fastapi.tiangolo.com/virtual-environments/) and then install FastAPI:
- <div class="termy">
- ```console
- $ pip install "fastapi[standard]"
- ---> 100%
- ```
- </div>
- **Note**: Make sure you put `"fastapi[standard]"` in quotes to ensure it works in all terminals.
- ## Example
- ### Create it
- Create a file `main.py` with:
- ```Python
- from fastapi import FastAPI
- app = FastAPI()
- @app.get("/")
- def read_root():
- return {"Hello": "World"}
- @app.get("/items/{item_id}")
- def read_item(item_id: int, q: str | None = None):
- return {"item_id": item_id, "q": q}
- ```
- <details markdown="1">
- <summary>Or use <code>async def</code>...</summary>
- If your code uses `async` / `await`, use `async def`:
- ```Python hl_lines="7 12"
- from fastapi import FastAPI
- app = FastAPI()
- @app.get("/")
- async def read_root():
- return {"Hello": "World"}
- @app.get("/items/{item_id}")
- async def read_item(item_id: int, q: str | None = None):
- return {"item_id": item_id, "q": q}
- ```
- **Note**:
- If you don't know, check the _"In a hurry?"_ section about [`async` and `await` in the docs](https://fastapi.tiangolo.com/async/#in-a-hurry).
- </details>
- ### Run it
- Run the server with:
- <div class="termy">
- ```console
- $ fastapi dev
- ╭────────── FastAPI CLI - Development mode ───────────╮
- │ │
- │ Serving at: http://127.0.0.1:8000 │
- │ │
- │ API docs: http://127.0.0.1:8000/docs │
- │ │
- │ Running in development mode, for production use: │
- │ │
- │ fastapi run │
- │ │
- ╰─────────────────────────────────────────────────────╯
- INFO: Will watch for changes in these directories: ['/home/user/code/awesomeapp']
- INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
- INFO: Started reloader process [2248755] using WatchFiles
- INFO: Started server process [2248757]
- INFO: Waiting for application startup.
- INFO: Application startup complete.
- ```
- </div>
- <details markdown="1">
- <summary>About the command <code>fastapi dev</code>...</summary>
- The command `fastapi dev` reads your `main.py` file automatically, detects the **FastAPI** app in it, and starts a server using [Uvicorn](https://www.uvicorn.dev).
- By default, `fastapi dev` will start with auto-reload enabled for local development.
- You can read more about it in the [FastAPI CLI docs](https://fastapi.tiangolo.com/fastapi-cli/).
- </details>
- ### Check it
- Open your browser at [http://127.0.0.1:8000/items/5?q=somequery](http://127.0.0.1:8000/items/5?q=somequery).
- You will see the JSON response as:
- ```JSON
- {"item_id": 5, "q": "somequery"}
- ```
- You already created an API that:
- * Receives HTTP requests in the _paths_ `/` and `/items/{item_id}`.
- * Both _paths_ take `GET` <em>operations</em> (also known as HTTP _methods_).
- * The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`.
- * The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`.
- ### Interactive API docs
- Now go to [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs).
- You will see the automatic interactive API documentation (provided by [Swagger UI](https://github.com/swagger-api/swagger-ui)):
- 
- ### Alternative API docs
- And now, go to [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc).
- You will see the alternative automatic documentation (provided by [ReDoc](https://github.com/Rebilly/ReDoc)):
- 
- ## Example upgrade
- Now modify the file `main.py` to receive a body from a `PUT` request.
- Declare the body using standard Python types, thanks to Pydantic.
- ```Python hl_lines="2 7-10 23-25"
- from fastapi import FastAPI
- from pydantic import BaseModel
- app = FastAPI()
- class Item(BaseModel):
- name: str
- price: float
- is_offer: bool | None = None
- @app.get("/")
- def read_root():
- return {"Hello": "World"}
- @app.get("/items/{item_id}")
- def read_item(item_id: int, q: str | None = None):
- return {"item_id": item_id, "q": q}
- @app.put("/items/{item_id}")
- def update_item(item_id: int, item: Item):
- return {"item_name": item.name, "item_id": item_id}
- ```
- The `fastapi dev` server should reload automatically.
- ### Interactive API docs upgrade
- Now go to [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs).
- * The interactive API documentation will be automatically updated, including the new body:
- 
- * Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API:
- 
- * Then click on the "Execute" button, the user interface will communicate with your API, send the parameters, get the results and show them on the screen:
- 
- ### Alternative API docs upgrade
- And now, go to [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc).
- * The alternative documentation will also reflect the new query parameter and body:
- 
- ### Recap
- In summary, you declare **once** the types of parameters, body, etc. as function parameters.
- You do that with standard modern Python types.
- You don't have to learn a new syntax, the methods or classes of a specific library, etc.
- Just standard **Python**.
- For example, for an `int`:
- ```Python
- item_id: int
- ```
- or for a more complex `Item` model:
- ```Python
- item: Item
- ```
- ...and with that single declaration you get:
- * Editor support, including:
- * Completion.
- * Type checks.
- * Validation of data:
- * Automatic and clear errors when the data is invalid.
- * Validation even for deeply nested JSON objects.
- * <dfn title="also known as: serialization, parsing, marshalling">Conversion</dfn> of input data: coming from the network to Python data and types. Reading from:
- * JSON.
- * Path parameters.
- * Query parameters.
- * Cookies.
- * Headers.
- * Forms.
- * Files.
- * <dfn title="also known as: serialization, parsing, marshalling">Conversion</dfn> of output data: converting from Python data and types to network data (as JSON):
- * Convert Python types (`str`, `int`, `float`, `bool`, `list`, etc).
- * `datetime` objects.
- * `UUID` objects.
- * Database models.
- * ...and many more.
- * Automatic interactive API documentation, including 2 alternative user interfaces:
- * Swagger UI.
- * ReDoc.
- ---
- Coming back to the previous code example, **FastAPI** will:
- * Validate that there is an `item_id` in the path for `GET` and `PUT` requests.
- * Validate that the `item_id` is of type `int` for `GET` and `PUT` requests.
- * If it is not, the client will see a useful, clear error.
- * Check if there is an optional query parameter named `q` (as in `http://127.0.0.1:8000/items/foo?q=somequery`) for `GET` requests.
- * As the `q` parameter is declared with `= None`, it is optional.
- * Without the `None` it would be required (as is the body in the case with `PUT`).
- * For `PUT` requests to `/items/{item_id}`, read the body as JSON:
- * Check that it has a required attribute `name` that should be a `str`.
- * Check that it has a required attribute `price` that has to be a `float`.
- * Check that it has an optional attribute `is_offer`, that should be a `bool`, if present.
- * All this would also work for deeply nested JSON objects.
- * Convert from and to JSON automatically.
- * Document everything with OpenAPI, that can be used by:
- * Interactive documentation systems.
- * Automatic client code generation systems, for many languages.
- * Provide 2 interactive documentation web interfaces directly.
- ---
- We just scratched the surface, but you already get the idea of how it all works.
- Try changing the line with:
- ```Python
- return {"item_name": item.name, "item_id": item_id}
- ```
- ...from:
- ```Python
- ... "item_name": item.name ...
- ```
- ...to:
- ```Python
- ... "item_price": item.price ...
- ```
- ...and see how your editor will auto-complete the attributes and know their types:
- 
- For a more complete example including more features, see the <a href="https://fastapi.tiangolo.com/tutorial/">Tutorial - User Guide</a>.
- **Spoiler alert**: the tutorial - user guide includes:
- * Declaration of **parameters** from other different places as: **headers**, **cookies**, **form fields** and **files**.
- * How to set **validation constraints** as `maximum_length` or `regex`.
- * A very powerful and easy to use **<dfn title="also known as components, resources, providers, services, injectables">Dependency Injection</dfn>** system.
- * Security and authentication, including support for **OAuth2** with **JWT tokens** and **HTTP Basic** auth.
- * More advanced (but equally easy) techniques for declaring **deeply nested JSON models** (thanks to Pydantic).
- * **GraphQL** integration with [Strawberry](https://strawberry.rocks) and other libraries.
- * Many extra features (thanks to Starlette) as:
- * **WebSockets**
- * extremely easy tests based on HTTPX and `pytest`
- * **CORS**
- * **Cookie Sessions**
- * ...and more.
- ### Deploy your app (optional)
- You can optionally deploy your FastAPI app to [FastAPI Cloud](https://fastapicloud.com), go and join the waiting list if you haven't. 🚀
- If you already have a **FastAPI Cloud** account (we invited you from the waiting list 😉), you can deploy your application with one command.
- <div class="termy">
- ```console
- $ fastapi deploy
- Deploying to FastAPI Cloud...
- ✅ Deployment successful!
- 🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev
- ```
- </div>
- That's it! Now you can access your app at that URL. ✨
- #### About FastAPI Cloud
- **[FastAPI Cloud](https://fastapicloud.com)** is built by the same author and team behind **FastAPI**.
- It streamlines the process of **building**, **deploying**, and **accessing** an API with minimal effort.
- It brings the same **developer experience** of building apps with FastAPI to **deploying** them to the cloud. 🎉
- FastAPI Cloud is the primary sponsor and funding provider for the *FastAPI and friends* open source projects. ✨
- #### Deploy to other cloud providers
- FastAPI is open source and based on standards. You can deploy FastAPI apps to any cloud provider you choose.
- Follow your cloud provider's guides to deploy FastAPI apps with them. 🤓
- ## Performance
- Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as [one of the fastest Python frameworks available](https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7), only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)
- To understand more about it, see the section [Benchmarks](https://fastapi.tiangolo.com/benchmarks/).
- ## Dependencies
- FastAPI depends on Pydantic and Starlette.
- ### `standard` Dependencies
- When you install FastAPI with `pip install "fastapi[standard]"` it comes with the `standard` group of optional dependencies:
- Used by Pydantic:
- * [`email-validator`](https://github.com/JoshData/python-email-validator) - for email validation.
- Used by Starlette:
- * [`httpx`](https://www.python-httpx.org) - Required if you want to use the `TestClient`.
- * [`jinja2`](https://jinja.palletsprojects.com) - Required if you want to use the default template configuration.
- * [`python-multipart`](https://github.com/Kludex/python-multipart) - Required if you want to support form <dfn title="converting the string that comes from an HTTP request into Python data">"parsing"</dfn>, with `request.form()`.
- Used by FastAPI:
- * [`uvicorn`](https://www.uvicorn.dev) - for the server that loads and serves your application. This includes `uvicorn[standard]`, which includes some dependencies (e.g. `uvloop`) needed for high performance serving.
- * `fastapi-cli[standard]` - to provide the `fastapi` command.
- * This includes `fastapi-cloud-cli`, which allows you to deploy your FastAPI application to [FastAPI Cloud](https://fastapicloud.com).
- ### Without `standard` Dependencies
- If you don't want to include the `standard` optional dependencies, you can install with `pip install fastapi` instead of `pip install "fastapi[standard]"`.
- ### Without `fastapi-cloud-cli`
- If you want to install FastAPI with the standard dependencies but without the `fastapi-cloud-cli`, you can install with `pip install "fastapi[standard-no-fastapi-cloud-cli]"`.
- ### Additional Optional Dependencies
- There are some additional dependencies you might want to install.
- Additional optional Pydantic dependencies:
- * [`pydantic-settings`](https://docs.pydantic.dev/latest/usage/pydantic_settings/) - for settings management.
- * [`pydantic-extra-types`](https://docs.pydantic.dev/latest/usage/types/extra_types/extra_types/) - for extra types to be used with Pydantic.
- Additional optional FastAPI dependencies:
- * [`orjson`](https://github.com/ijl/orjson) - Required if you want to use `ORJSONResponse`.
- * [`ujson`](https://github.com/esnme/ultrajson) - Required if you want to use `UJSONResponse`.
- ## License
- This project is licensed under the terms of the MIT license.
|