METADATA 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562
  1. Metadata-Version: 2.1
  2. Name: fastapi
  3. Version: 0.115.6
  4. Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
  5. Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
  6. Classifier: Intended Audience :: Information Technology
  7. Classifier: Intended Audience :: System Administrators
  8. Classifier: Operating System :: OS Independent
  9. Classifier: Programming Language :: Python :: 3
  10. Classifier: Programming Language :: Python
  11. Classifier: Topic :: Internet
  12. Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
  13. Classifier: Topic :: Software Development :: Libraries :: Python Modules
  14. Classifier: Topic :: Software Development :: Libraries
  15. Classifier: Topic :: Software Development
  16. Classifier: Typing :: Typed
  17. Classifier: Development Status :: 4 - Beta
  18. Classifier: Environment :: Web Environment
  19. Classifier: Framework :: AsyncIO
  20. Classifier: Framework :: FastAPI
  21. Classifier: Framework :: Pydantic
  22. Classifier: Framework :: Pydantic :: 1
  23. Classifier: Intended Audience :: Developers
  24. Classifier: License :: OSI Approved :: MIT License
  25. Classifier: Programming Language :: Python :: 3 :: Only
  26. Classifier: Programming Language :: Python :: 3.8
  27. Classifier: Programming Language :: Python :: 3.9
  28. Classifier: Programming Language :: Python :: 3.10
  29. Classifier: Programming Language :: Python :: 3.11
  30. Classifier: Programming Language :: Python :: 3.12
  31. Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
  32. Classifier: Topic :: Internet :: WWW/HTTP
  33. Project-URL: Homepage, https://github.com/fastapi/fastapi
  34. Project-URL: Documentation, https://fastapi.tiangolo.com/
  35. Project-URL: Repository, https://github.com/fastapi/fastapi
  36. Project-URL: Issues, https://github.com/fastapi/fastapi/issues
  37. Project-URL: Changelog, https://fastapi.tiangolo.com/release-notes/
  38. Requires-Python: >=3.8
  39. Requires-Dist: starlette<0.42.0,>=0.40.0
  40. Requires-Dist: pydantic!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.7.4
  41. Requires-Dist: typing-extensions>=4.8.0
  42. Provides-Extra: standard
  43. Requires-Dist: fastapi-cli[standard]>=0.0.5; extra == "standard"
  44. Requires-Dist: httpx>=0.23.0; extra == "standard"
  45. Requires-Dist: jinja2>=2.11.2; extra == "standard"
  46. Requires-Dist: python-multipart>=0.0.7; extra == "standard"
  47. Requires-Dist: email-validator>=2.0.0; extra == "standard"
  48. Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard"
  49. Provides-Extra: all
  50. Requires-Dist: fastapi-cli[standard]>=0.0.5; extra == "all"
  51. Requires-Dist: httpx>=0.23.0; extra == "all"
  52. Requires-Dist: jinja2>=2.11.2; extra == "all"
  53. Requires-Dist: python-multipart>=0.0.7; extra == "all"
  54. Requires-Dist: itsdangerous>=1.1.0; extra == "all"
  55. Requires-Dist: pyyaml>=5.3.1; extra == "all"
  56. Requires-Dist: ujson!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,>=4.0.1; extra == "all"
  57. Requires-Dist: orjson>=3.2.1; extra == "all"
  58. Requires-Dist: email-validator>=2.0.0; extra == "all"
  59. Requires-Dist: uvicorn[standard]>=0.12.0; extra == "all"
  60. Requires-Dist: pydantic-settings>=2.0.0; extra == "all"
  61. Requires-Dist: pydantic-extra-types>=2.0.0; extra == "all"
  62. Description-Content-Type: text/markdown
  63. <p align="center">
  64. <a href="https://fastapi.tiangolo.com"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI"></a>
  65. </p>
  66. <p align="center">
  67. <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
  68. </p>
  69. <p align="center">
  70. <a href="https://github.com/fastapi/fastapi/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster" target="_blank">
  71. <img src="https://github.com/fastapi/fastapi/workflows/Test/badge.svg?event=push&branch=master" alt="Test">
  72. </a>
  73. <a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/fastapi" target="_blank">
  74. <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/fastapi.svg" alt="Coverage">
  75. </a>
  76. <a href="https://pypi.org/project/fastapi" target="_blank">
  77. <img src="https://img.shields.io/pypi/v/fastapi?color=%2334D058&label=pypi%20package" alt="Package version">
  78. </a>
  79. <a href="https://pypi.org/project/fastapi" target="_blank">
  80. <img src="https://img.shields.io/pypi/pyversions/fastapi.svg?color=%2334D058" alt="Supported Python versions">
  81. </a>
  82. </p>
  83. ---
  84. **Documentation**: <a href="https://fastapi.tiangolo.com" target="_blank">https://fastapi.tiangolo.com</a>
  85. **Source Code**: <a href="https://github.com/fastapi/fastapi" target="_blank">https://github.com/fastapi/fastapi</a>
  86. ---
  87. FastAPI is a modern, fast (high-performance), web framework for building APIs with Python based on standard Python type hints.
  88. The key features are:
  89. * **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance).
  90. * **Fast to code**: Increase the speed to develop features by about 200% to 300%. *
  91. * **Fewer bugs**: Reduce about 40% of human (developer) induced errors. *
  92. * **Intuitive**: Great editor support. <abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> everywhere. Less time debugging.
  93. * **Easy**: Designed to be easy to use and learn. Less time reading docs.
  94. * **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.
  95. * **Robust**: Get production-ready code. With automatic interactive documentation.
  96. * **Standards-based**: Based on (and fully compatible with) the open standards for APIs: <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> (previously known as Swagger) and <a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>.
  97. <small>* estimation based on tests on an internal development team, building production applications.</small>
  98. ## Sponsors
  99. <!-- sponsors -->
  100. <a href="https://cryptapi.io/" target="_blank" title="CryptAPI: Your easy to use, secure and privacy oriented payment gateway."><img src="https://fastapi.tiangolo.com/img/sponsors/cryptapi.svg"></a>
  101. <a href="https://platform.sh/try-it-now/?utm_source=fastapi-signup&utm_medium=banner&utm_campaign=FastAPI-signup-June-2023" target="_blank" title="Build, run and scale your apps on a modern, reliable, and secure PaaS."><img src="https://fastapi.tiangolo.com/img/sponsors/platform-sh.png"></a>
  102. <a href="https://www.porter.run" target="_blank" title="Deploy FastAPI on AWS with a few clicks"><img src="https://fastapi.tiangolo.com/img/sponsors/porter.png"></a>
  103. <a href="https://bump.sh/fastapi?utm_source=fastapi&utm_medium=referral&utm_campaign=sponsor" target="_blank" title="Automate FastAPI documentation generation with Bump.sh"><img src="https://fastapi.tiangolo.com/img/sponsors/bump-sh.svg"></a>
  104. <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>
  105. <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>
  106. <a href="https://www.withcoherence.com/?utm_medium=advertising&utm_source=fastapi&utm_campaign=website" target="_blank" title="Coherence"><img src="https://fastapi.tiangolo.com/img/sponsors/coherence.png"></a>
  107. <a href="https://www.mongodb.com/developer/languages/python/python-quickstart-fastapi/?utm_campaign=fastapi_framework&utm_source=fastapi_sponsorship&utm_medium=web_referral" target="_blank" title="Simplify Full Stack Development with FastAPI & MongoDB"><img src="https://fastapi.tiangolo.com/img/sponsors/mongodb.png"></a>
  108. <a href="https://zuplo.link/fastapi-gh" target="_blank" title="Zuplo: Scale, Protect, Document, and Monetize your FastAPI"><img src="https://fastapi.tiangolo.com/img/sponsors/zuplo.png"></a>
  109. <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>
  110. <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>
  111. <a href="https://github.com/deepset-ai/haystack/" target="_blank" title="Build powerful search from composable, open source building blocks"><img src="https://fastapi.tiangolo.com/img/sponsors/haystack-fastapi.svg"></a>
  112. <a href="https://databento.com/" target="_blank" title="Pay as you go for market data"><img src="https://fastapi.tiangolo.com/img/sponsors/databento.svg"></a>
  113. <a href="https://speakeasy.com?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>
  114. <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>
  115. <a href="https://www.codacy.com/?utm_source=github&utm_medium=sponsors&utm_id=pioneers" target="_blank" title="Take code reviews from hours to minutes"><img src="https://fastapi.tiangolo.com/img/sponsors/codacy.png"></a>
  116. <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>
  117. <!-- /sponsors -->
  118. <a href="https://fastapi.tiangolo.com/fastapi-people/#sponsors" class="external-link" target="_blank">Other sponsors</a>
  119. ## Opinions
  120. "_[...] 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._"
  121. <div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/fastapi/fastapi/pull/26" target="_blank"><small>(ref)</small></a></div>
  122. ---
  123. "_We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]_"
  124. <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/" target="_blank"><small>(ref)</small></a></div>
  125. ---
  126. "_**Netflix** is pleased to announce the open-source release of our **crisis management** orchestration framework: **Dispatch**! [built with **FastAPI**]_"
  127. <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" target="_blank"><small>(ref)</small></a></div>
  128. ---
  129. "_I’m over the moon excited about **FastAPI**. It’s so fun!_"
  130. <div style="text-align: right; margin-right: 10%;">Brian Okken - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">Python Bytes</a> podcast host</strong> <a href="https://twitter.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div>
  131. ---
  132. "_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._"
  133. <div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="https://github.com/hugapi/hug" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div>
  134. ---
  135. "_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 [...]_"
  136. "_We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]_"
  137. <div style="text-align: right; margin-right: 10%;">Ines Montani - Matthew Honnibal - <strong><a href="https://explosion.ai" target="_blank">Explosion AI</a> founders - <a href="https://spacy.io" target="_blank">spaCy</a> creators</strong> <a href="https://twitter.com/_inesmontani/status/1144173225322143744" target="_blank"><small>(ref)</small></a> - <a href="https://twitter.com/honnibal/status/1144031421859655680" target="_blank"><small>(ref)</small></a></div>
  138. ---
  139. "_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._"
  140. <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/" target="_blank"><small>(ref)</small></a></div>
  141. ---
  142. ## **Typer**, the FastAPI of CLIs
  143. <a href="https://typer.tiangolo.com" target="_blank"><img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" style="width: 20%;"></a>
  144. 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 <a href="https://typer.tiangolo.com/" class="external-link" target="_blank">**Typer**</a>.
  145. **Typer** is FastAPI's little sibling. And it's intended to be the **FastAPI of CLIs**. ⌨️ 🚀
  146. ## Requirements
  147. FastAPI stands on the shoulders of giants:
  148. * <a href="https://www.starlette.io/" class="external-link" target="_blank">Starlette</a> for the web parts.
  149. * <a href="https://docs.pydantic.dev/" class="external-link" target="_blank">Pydantic</a> for the data parts.
  150. ## Installation
  151. Create and activate a <a href="https://fastapi.tiangolo.com/virtual-environments/" class="external-link" target="_blank">virtual environment</a> and then install FastAPI:
  152. <div class="termy">
  153. ```console
  154. $ pip install "fastapi[standard]"
  155. ---> 100%
  156. ```
  157. </div>
  158. **Note**: Make sure you put `"fastapi[standard]"` in quotes to ensure it works in all terminals.
  159. ## Example
  160. ### Create it
  161. * Create a file `main.py` with:
  162. ```Python
  163. from typing import Union
  164. from fastapi import FastAPI
  165. app = FastAPI()
  166. @app.get("/")
  167. def read_root():
  168. return {"Hello": "World"}
  169. @app.get("/items/{item_id}")
  170. def read_item(item_id: int, q: Union[str, None] = None):
  171. return {"item_id": item_id, "q": q}
  172. ```
  173. <details markdown="1">
  174. <summary>Or use <code>async def</code>...</summary>
  175. If your code uses `async` / `await`, use `async def`:
  176. ```Python hl_lines="9 14"
  177. from typing import Union
  178. from fastapi import FastAPI
  179. app = FastAPI()
  180. @app.get("/")
  181. async def read_root():
  182. return {"Hello": "World"}
  183. @app.get("/items/{item_id}")
  184. async def read_item(item_id: int, q: Union[str, None] = None):
  185. return {"item_id": item_id, "q": q}
  186. ```
  187. **Note**:
  188. If you don't know, check the _"In a hurry?"_ section about <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank">`async` and `await` in the docs</a>.
  189. </details>
  190. ### Run it
  191. Run the server with:
  192. <div class="termy">
  193. ```console
  194. $ fastapi dev main.py
  195. ╭────────── FastAPI CLI - Development mode ───────────╮
  196. │ │
  197. │ Serving at: http://127.0.0.1:8000 │
  198. │ │
  199. │ API docs: http://127.0.0.1:8000/docs │
  200. │ │
  201. │ Running in development mode, for production use: │
  202. │ │
  203. │ fastapi run │
  204. │ │
  205. ╰─────────────────────────────────────────────────────╯
  206. INFO: Will watch for changes in these directories: ['/home/user/code/awesomeapp']
  207. INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
  208. INFO: Started reloader process [2248755] using WatchFiles
  209. INFO: Started server process [2248757]
  210. INFO: Waiting for application startup.
  211. INFO: Application startup complete.
  212. ```
  213. </div>
  214. <details markdown="1">
  215. <summary>About the command <code>fastapi dev main.py</code>...</summary>
  216. The command `fastapi dev` reads your `main.py` file, detects the **FastAPI** app in it, and starts a server using <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a>.
  217. By default, `fastapi dev` will start with auto-reload enabled for local development.
  218. You can read more about it in the <a href="https://fastapi.tiangolo.com/fastapi-cli/" target="_blank">FastAPI CLI docs</a>.
  219. </details>
  220. ### Check it
  221. Open your browser at <a href="http://127.0.0.1:8000/items/5?q=somequery" class="external-link" target="_blank">http://127.0.0.1:8000/items/5?q=somequery</a>.
  222. You will see the JSON response as:
  223. ```JSON
  224. {"item_id": 5, "q": "somequery"}
  225. ```
  226. You already created an API that:
  227. * Receives HTTP requests in the _paths_ `/` and `/items/{item_id}`.
  228. * Both _paths_ take `GET` <em>operations</em> (also known as HTTP _methods_).
  229. * The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`.
  230. * The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`.
  231. ### Interactive API docs
  232. Now go to <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
  233. You will see the automatic interactive API documentation (provided by <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>):
  234. ![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)
  235. ### Alternative API docs
  236. And now, go to <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>.
  237. You will see the alternative automatic documentation (provided by <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a>):
  238. ![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png)
  239. ## Example upgrade
  240. Now modify the file `main.py` to receive a body from a `PUT` request.
  241. Declare the body using standard Python types, thanks to Pydantic.
  242. ```Python hl_lines="4 9-12 25-27"
  243. from typing import Union
  244. from fastapi import FastAPI
  245. from pydantic import BaseModel
  246. app = FastAPI()
  247. class Item(BaseModel):
  248. name: str
  249. price: float
  250. is_offer: Union[bool, None] = None
  251. @app.get("/")
  252. def read_root():
  253. return {"Hello": "World"}
  254. @app.get("/items/{item_id}")
  255. def read_item(item_id: int, q: Union[str, None] = None):
  256. return {"item_id": item_id, "q": q}
  257. @app.put("/items/{item_id}")
  258. def update_item(item_id: int, item: Item):
  259. return {"item_name": item.name, "item_id": item_id}
  260. ```
  261. The `fastapi dev` server should reload automatically.
  262. ### Interactive API docs upgrade
  263. Now go to <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
  264. * The interactive API documentation will be automatically updated, including the new body:
  265. ![Swagger UI](https://fastapi.tiangolo.com/img/index/index-03-swagger-02.png)
  266. * Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API:
  267. ![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-04-swagger-03.png)
  268. * 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:
  269. ![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-05-swagger-04.png)
  270. ### Alternative API docs upgrade
  271. And now, go to <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>.
  272. * The alternative documentation will also reflect the new query parameter and body:
  273. ![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png)
  274. ### Recap
  275. In summary, you declare **once** the types of parameters, body, etc. as function parameters.
  276. You do that with standard modern Python types.
  277. You don't have to learn a new syntax, the methods or classes of a specific library, etc.
  278. Just standard **Python**.
  279. For example, for an `int`:
  280. ```Python
  281. item_id: int
  282. ```
  283. or for a more complex `Item` model:
  284. ```Python
  285. item: Item
  286. ```
  287. ...and with that single declaration you get:
  288. * Editor support, including:
  289. * Completion.
  290. * Type checks.
  291. * Validation of data:
  292. * Automatic and clear errors when the data is invalid.
  293. * Validation even for deeply nested JSON objects.
  294. * <abbr title="also known as: serialization, parsing, marshalling">Conversion</abbr> of input data: coming from the network to Python data and types. Reading from:
  295. * JSON.
  296. * Path parameters.
  297. * Query parameters.
  298. * Cookies.
  299. * Headers.
  300. * Forms.
  301. * Files.
  302. * <abbr title="also known as: serialization, parsing, marshalling">Conversion</abbr> of output data: converting from Python data and types to network data (as JSON):
  303. * Convert Python types (`str`, `int`, `float`, `bool`, `list`, etc).
  304. * `datetime` objects.
  305. * `UUID` objects.
  306. * Database models.
  307. * ...and many more.
  308. * Automatic interactive API documentation, including 2 alternative user interfaces:
  309. * Swagger UI.
  310. * ReDoc.
  311. ---
  312. Coming back to the previous code example, **FastAPI** will:
  313. * Validate that there is an `item_id` in the path for `GET` and `PUT` requests.
  314. * Validate that the `item_id` is of type `int` for `GET` and `PUT` requests.
  315. * If it is not, the client will see a useful, clear error.
  316. * 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.
  317. * As the `q` parameter is declared with `= None`, it is optional.
  318. * Without the `None` it would be required (as is the body in the case with `PUT`).
  319. * For `PUT` requests to `/items/{item_id}`, read the body as JSON:
  320. * Check that it has a required attribute `name` that should be a `str`.
  321. * Check that it has a required attribute `price` that has to be a `float`.
  322. * Check that it has an optional attribute `is_offer`, that should be a `bool`, if present.
  323. * All this would also work for deeply nested JSON objects.
  324. * Convert from and to JSON automatically.
  325. * Document everything with OpenAPI, that can be used by:
  326. * Interactive documentation systems.
  327. * Automatic client code generation systems, for many languages.
  328. * Provide 2 interactive documentation web interfaces directly.
  329. ---
  330. We just scratched the surface, but you already get the idea of how it all works.
  331. Try changing the line with:
  332. ```Python
  333. return {"item_name": item.name, "item_id": item_id}
  334. ```
  335. ...from:
  336. ```Python
  337. ... "item_name": item.name ...
  338. ```
  339. ...to:
  340. ```Python
  341. ... "item_price": item.price ...
  342. ```
  343. ...and see how your editor will auto-complete the attributes and know their types:
  344. ![editor support](https://fastapi.tiangolo.com/img/vscode-completion.png)
  345. For a more complete example including more features, see the <a href="https://fastapi.tiangolo.com/tutorial/">Tutorial - User Guide</a>.
  346. **Spoiler alert**: the tutorial - user guide includes:
  347. * Declaration of **parameters** from other different places as: **headers**, **cookies**, **form fields** and **files**.
  348. * How to set **validation constraints** as `maximum_length` or `regex`.
  349. * A very powerful and easy to use **<abbr title="also known as components, resources, providers, services, injectables">Dependency Injection</abbr>** system.
  350. * Security and authentication, including support for **OAuth2** with **JWT tokens** and **HTTP Basic** auth.
  351. * More advanced (but equally easy) techniques for declaring **deeply nested JSON models** (thanks to Pydantic).
  352. * **GraphQL** integration with <a href="https://strawberry.rocks" class="external-link" target="_blank">Strawberry</a> and other libraries.
  353. * Many extra features (thanks to Starlette) as:
  354. * **WebSockets**
  355. * extremely easy tests based on HTTPX and `pytest`
  356. * **CORS**
  357. * **Cookie Sessions**
  358. * ...and more.
  359. ## Performance
  360. Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as <a href="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7" class="external-link" target="_blank">one of the fastest Python frameworks available</a>, only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)
  361. To understand more about it, see the section <a href="https://fastapi.tiangolo.com/benchmarks/" class="internal-link" target="_blank">Benchmarks</a>.
  362. ## Dependencies
  363. FastAPI depends on Pydantic and Starlette.
  364. ### `standard` Dependencies
  365. When you install FastAPI with `pip install "fastapi[standard]"` it comes the `standard` group of optional dependencies:
  366. Used by Pydantic:
  367. * <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email-validator</code></a> - for email validation.
  368. Used by Starlette:
  369. * <a href="https://www.python-httpx.org" target="_blank"><code>httpx</code></a> - Required if you want to use the `TestClient`.
  370. * <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration.
  371. * <a href="https://github.com/Kludex/python-multipart" target="_blank"><code>python-multipart</code></a> - Required if you want to support form <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>, with `request.form()`.
  372. Used by FastAPI / Starlette:
  373. * <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - 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.
  374. * `fastapi-cli` - to provide the `fastapi` command.
  375. ### Without `standard` Dependencies
  376. If you don't want to include the `standard` optional dependencies, you can install with `pip install fastapi` instead of `pip install "fastapi[standard]"`.
  377. ### Additional Optional Dependencies
  378. There are some additional dependencies you might want to install.
  379. Additional optional Pydantic dependencies:
  380. * <a href="https://docs.pydantic.dev/latest/usage/pydantic_settings/" target="_blank"><code>pydantic-settings</code></a> - for settings management.
  381. * <a href="https://docs.pydantic.dev/latest/usage/types/extra_types/extra_types/" target="_blank"><code>pydantic-extra-types</code></a> - for extra types to be used with Pydantic.
  382. Additional optional FastAPI dependencies:
  383. * <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`.
  384. * <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
  385. ## License
  386. This project is licensed under the terms of the MIT license.