pollutri
/
res_levis_API
1
0
派生 0
代码 工单 0 合并请求 0 版本发布 0 百科 动态
您最多选择25个主题 主题必须以字母或数字开头，可以包含连字符 (-)，并且长度不得超过35个字符
5 提交
1 分支
203 MiB
 
 
 
 
目录树: 1141c5ca64
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 '1141c5ca64'
${ noResults }
res_levis_API/.venv/lib/python3.10/site-packages/fastapi-0.116.1.dist-info/METADATA

576 行
28 KiB
原始文件 Blame 文件历史 

  1. Metadata-Version: 2.1

  2. Name: fastapi

  3. Version: 0.116.1

  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: Framework :: Pydantic :: 2

  24. Classifier: Intended Audience :: Developers

  25. Classifier: License :: OSI Approved :: MIT License

  26. Classifier: Programming Language :: Python :: 3 :: Only

  27. Classifier: Programming Language :: Python :: 3.8

  28. Classifier: Programming Language :: Python :: 3.9

  29. Classifier: Programming Language :: Python :: 3.10

  30. Classifier: Programming Language :: Python :: 3.11

  31. Classifier: Programming Language :: Python :: 3.12

  32. Classifier: Programming Language :: Python :: 3.13

  33. Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers

  34. Classifier: Topic :: Internet :: WWW/HTTP

  35. Project-URL: Homepage, https://github.com/fastapi/fastapi

  36. Project-URL: Documentation, https://fastapi.tiangolo.com/

  37. Project-URL: Repository, https://github.com/fastapi/fastapi

  38. Project-URL: Issues, https://github.com/fastapi/fastapi/issues

  39. Project-URL: Changelog, https://fastapi.tiangolo.com/release-notes/

  40. Requires-Python: >=3.8

  41. Requires-Dist: starlette<0.48.0,>=0.40.0

  42. Requires-Dist: pydantic!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.7.4

  43. Requires-Dist: typing-extensions>=4.8.0

  44. Provides-Extra: standard

  45. Requires-Dist: fastapi-cli[standard]>=0.0.8; extra == "standard"

  46. Requires-Dist: httpx>=0.23.0; extra == "standard"

  47. Requires-Dist: jinja2>=3.1.5; extra == "standard"

  48. Requires-Dist: python-multipart>=0.0.18; extra == "standard"

  49. Requires-Dist: email-validator>=2.0.0; extra == "standard"

  50. Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard"

  51. Provides-Extra: standard-no-fastapi-cloud-cli

  52. Requires-Dist: fastapi-cli[standard-no-fastapi-cloud-cli]>=0.0.8; extra == "standard-no-fastapi-cloud-cli"

  53. Requires-Dist: httpx>=0.23.0; extra == "standard-no-fastapi-cloud-cli"

  54. Requires-Dist: jinja2>=3.1.5; extra == "standard-no-fastapi-cloud-cli"

  55. Requires-Dist: python-multipart>=0.0.18; extra == "standard-no-fastapi-cloud-cli"

  56. Requires-Dist: email-validator>=2.0.0; extra == "standard-no-fastapi-cloud-cli"

  57. Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard-no-fastapi-cloud-cli"

  58. Provides-Extra: all

  59. Requires-Dist: fastapi-cli[standard]>=0.0.8; extra == "all"

  60. Requires-Dist: httpx>=0.23.0; extra == "all"

  61. Requires-Dist: jinja2>=3.1.5; extra == "all"

  62. Requires-Dist: python-multipart>=0.0.18; extra == "all"

  63. Requires-Dist: itsdangerous>=1.1.0; extra == "all"

  64. Requires-Dist: pyyaml>=5.3.1; extra == "all"

  65. 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"

  66. Requires-Dist: orjson>=3.2.1; extra == "all"

  67. Requires-Dist: email-validator>=2.0.0; extra == "all"

  68. Requires-Dist: uvicorn[standard]>=0.12.0; extra == "all"

  69. Requires-Dist: pydantic-settings>=2.0.0; extra == "all"

  70. Requires-Dist: pydantic-extra-types>=2.0.0; extra == "all"

  71. Description-Content-Type: text/markdown

  72. 

  73. <p align="center">

  74.   <a href="https://fastapi.tiangolo.com"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI"></a>

  75. </p>

  76. <p align="center">

  77.     <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>

  78. </p>

  79. <p align="center">

  80. <a href="https://github.com/fastapi/fastapi/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster" target="_blank">

  81.     <img src="https://github.com/fastapi/fastapi/actions/workflows/test.yml/badge.svg?event=push&branch=master" alt="Test">

  82. </a>

  83. <a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/fastapi" target="_blank">

  84.     <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/fastapi.svg" alt="Coverage">

  85. </a>

  86. <a href="https://pypi.org/project/fastapi" target="_blank">

  87.     <img src="https://img.shields.io/pypi/v/fastapi?color=%2334D058&label=pypi%20package" alt="Package version">

  88. </a>

  89. <a href="https://pypi.org/project/fastapi" target="_blank">

  90.     <img src="https://img.shields.io/pypi/pyversions/fastapi.svg?color=%2334D058" alt="Supported Python versions">

  91. </a>

  92. </p>

  93. 

  94. ---

  95. 

  96. **Documentation**: <a href="https://fastapi.tiangolo.com" target="_blank">https://fastapi.tiangolo.com</a>

  97. 

  98. **Source Code**: <a href="https://github.com/fastapi/fastapi" target="_blank">https://github.com/fastapi/fastapi</a>

  99. 

  100. ---

  101. 

  102. FastAPI is a modern, fast (high-performance), web framework for building APIs with Python based on standard Python type hints.

  103. 

  104. The key features are:

  105. 

  106. * **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance).

  107. * **Fast to code**: Increase the speed to develop features by about 200% to 300%. *

  108. * **Fewer bugs**: Reduce about 40% of human (developer) induced errors. *

  109. * **Intuitive**: Great editor support. <abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> everywhere. Less time debugging.

  110. * **Easy**: Designed to be easy to use and learn. Less time reading docs.

  111. * **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.

  112. * **Robust**: Get production-ready code. With automatic interactive documentation.

  113. * **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>.

  114. 

  115. <small>* estimation based on tests on an internal development team, building production applications.</small>

  116. 

  117. ## Sponsors

  118. 

  119. <!-- sponsors -->

  120. 

  121. <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>

  122. <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>

  123. <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>

  124. <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>

  125. <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>

  126. <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>

  127. <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>

  128. <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>

  129. <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>

  130. <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>

  131. <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>

  132. <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>

  133. <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>

  134. <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>

  135. <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>

  136. <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>

  137. 

  138. <!-- /sponsors -->

  139. 

  140. <a href="https://fastapi.tiangolo.com/fastapi-people/#sponsors" class="external-link" target="_blank">Other sponsors</a>

  141. 

  142. ## Opinions

  143. 

  144. "_[...] 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._"

  145. 

  146. <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>

  147. 

  148. ---

  149. 

  150. "_We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]_"

  151. 

  152. <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>

  153. 

  154. ---

  155. 

  156. "_**Netflix** is pleased to announce the open-source release of our **crisis management** orchestration framework: **Dispatch**! [built with **FastAPI**]_"

  157. 

  158. <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>

  159. 

  160. ---

  161. 

  162. "_I’m over the moon excited about **FastAPI**. It’s so fun!_"

  163. 

  164. <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>

  165. 

  166. ---

  167. 

  168. "_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._"

  169. 

  170. <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>

  171. 

  172. ---

  173. 

  174. "_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 [...]_"

  175. 

  176. "_We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]_"

  177. 

  178. <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>

  179. 

  180. ---

  181. 

  182. "_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._"

  183. 

  184. <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>

  185. 

  186. ---

  187. 

  188. ## **Typer**, the FastAPI of CLIs

  189. 

  190. <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>

  191. 

  192. 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>.

  193. 

  194. **Typer** is FastAPI's little sibling. And it's intended to be the **FastAPI of CLIs**. ⌨️ 🚀

  195. 

  196. ## Requirements

  197. 

  198. FastAPI stands on the shoulders of giants:

  199. 

  200. * <a href="https://www.starlette.io/" class="external-link" target="_blank">Starlette</a> for the web parts.

  201. * <a href="https://docs.pydantic.dev/" class="external-link" target="_blank">Pydantic</a> for the data parts.

  202. 

  203. ## Installation

  204. 

  205. Create and activate a <a href="https://fastapi.tiangolo.com/virtual-environments/" class="external-link" target="_blank">virtual environment</a> and then install FastAPI:

  206. 

  207. <div class="termy">

  208. 

  209. ```console

  210. $ pip install "fastapi[standard]"

  211. 

  212. ---> 100%

  213. ```

  214. 

  215. </div>

  216. 

  217. **Note**: Make sure you put `"fastapi[standard]"` in quotes to ensure it works in all terminals.

  218. 

  219. ## Example

  220. 

  221. ### Create it

  222. 

  223. Create a file `main.py` with:

  224. 

  225. ```Python

  226. from typing import Union

  227. 

  228. from fastapi import FastAPI

  229. 

  230. app = FastAPI()

  231. 

  232. 

  233. @app.get("/")

  234. def read_root():

  235.     return {"Hello": "World"}

  236. 

  237. 

  238. @app.get("/items/{item_id}")

  239. def read_item(item_id: int, q: Union[str, None] = None):

  240.     return {"item_id": item_id, "q": q}

  241. ```

  242. 

  243. <details markdown="1">

  244. <summary>Or use <code>async def</code>...</summary>

  245. 

  246. If your code uses `async` / `await`, use `async def`:

  247. 

  248. ```Python hl_lines="9  14"

  249. from typing import Union

  250. 

  251. from fastapi import FastAPI

  252. 

  253. app = FastAPI()

  254. 

  255. 

  256. @app.get("/")

  257. async def read_root():

  258.     return {"Hello": "World"}

  259. 

  260. 

  261. @app.get("/items/{item_id}")

  262. async def read_item(item_id: int, q: Union[str, None] = None):

  263.     return {"item_id": item_id, "q": q}

  264. ```

  265. 

  266. **Note**:

  267. 

  268. 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>.

  269. 

  270. </details>

  271. 

  272. ### Run it

  273. 

  274. Run the server with:

  275. 

  276. <div class="termy">

  277. 

  278. ```console

  279. $ fastapi dev main.py

  280. 

  281.  ╭────────── FastAPI CLI - Development mode ───────────╮

  282.  │                                                     │

  283.  │  Serving at: http://127.0.0.1:8000                  │

  284.  │                                                     │

  285.  │  API docs: http://127.0.0.1:8000/docs               │

  286.  │                                                     │

  287.  │  Running in development mode, for production use:   │

  288.  │                                                     │

  289.  │  fastapi run                                        │

  290.  │                                                     │

  291.  ╰─────────────────────────────────────────────────────╯

  292. 

  293. INFO:     Will watch for changes in these directories: ['/home/user/code/awesomeapp']

  294. INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

  295. INFO:     Started reloader process [2248755] using WatchFiles

  296. INFO:     Started server process [2248757]

  297. INFO:     Waiting for application startup.

  298. INFO:     Application startup complete.

  299. ```

  300. 

  301. </div>

  302. 

  303. <details markdown="1">

  304. <summary>About the command <code>fastapi dev main.py</code>...</summary>

  305. 

  306. 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>.

  307. 

  308. By default, `fastapi dev` will start with auto-reload enabled for local development.

  309. 

  310. You can read more about it in the <a href="https://fastapi.tiangolo.com/fastapi-cli/" target="_blank">FastAPI CLI docs</a>.

  311. 

  312. </details>

  313. 

  314. ### Check it

  315. 

  316. 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>.

  317. 

  318. You will see the JSON response as:

  319. 

  320. ```JSON

  321. {"item_id": 5, "q": "somequery"}

  322. ```

  323. 

  324. You already created an API that:

  325. 

  326. * Receives HTTP requests in the _paths_ `/` and `/items/{item_id}`.

  327. * Both _paths_ take `GET` <em>operations</em> (also known as HTTP _methods_).

  328. * The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`.

  329. * The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`.

  330. 

  331. ### Interactive API docs

  332. 

  333. 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>.

  334. 

  335. 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>):

  336. 

  337. ![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)

  338. 

  339. ### Alternative API docs

  340. 

  341. 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>.

  342. 

  343. You will see the alternative automatic documentation (provided by <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a>):

  344. 

  345. ![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png)

  346. 

  347. ## Example upgrade

  348. 

  349. Now modify the file `main.py` to receive a body from a `PUT` request.

  350. 

  351. Declare the body using standard Python types, thanks to Pydantic.

  352. 

  353. ```Python hl_lines="4  9-12  25-27"

  354. from typing import Union

  355. 

  356. from fastapi import FastAPI

  357. from pydantic import BaseModel

  358. 

  359. app = FastAPI()

  360. 

  361. 

  362. class Item(BaseModel):

  363.     name: str

  364.     price: float

  365.     is_offer: Union[bool, None] = None

  366. 

  367. 

  368. @app.get("/")

  369. def read_root():

  370.     return {"Hello": "World"}

  371. 

  372. 

  373. @app.get("/items/{item_id}")

  374. def read_item(item_id: int, q: Union[str, None] = None):

  375.     return {"item_id": item_id, "q": q}

  376. 

  377. 

  378. @app.put("/items/{item_id}")

  379. def update_item(item_id: int, item: Item):

  380.     return {"item_name": item.name, "item_id": item_id}

  381. ```

  382. 

  383. The `fastapi dev` server should reload automatically.

  384. 

  385. ### Interactive API docs upgrade

  386. 

  387. 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>.

  388. 

  389. * The interactive API documentation will be automatically updated, including the new body:

  390. 

  391. ![Swagger UI](https://fastapi.tiangolo.com/img/index/index-03-swagger-02.png)

  392. 

  393. * Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API:

  394. 

  395. ![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-04-swagger-03.png)

  396. 

  397. * 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:

  398. 

  399. ![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-05-swagger-04.png)

  400. 

  401. ### Alternative API docs upgrade

  402. 

  403. 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>.

  404. 

  405. * The alternative documentation will also reflect the new query parameter and body:

  406. 

  407. ![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png)

  408. 

  409. ### Recap

  410. 

  411. In summary, you declare **once** the types of parameters, body, etc. as function parameters.

  412. 

  413. You do that with standard modern Python types.

  414. 

  415. You don't have to learn a new syntax, the methods or classes of a specific library, etc.

  416. 

  417. Just standard **Python**.

  418. 

  419. For example, for an `int`:

  420. 

  421. ```Python

  422. item_id: int

  423. ```

  424. 

  425. or for a more complex `Item` model:

  426. 

  427. ```Python

  428. item: Item

  429. ```

  430. 

  431. ...and with that single declaration you get:

  432. 

  433. * Editor support, including:

  434.     * Completion.

  435.     * Type checks.

  436. * Validation of data:

  437.     * Automatic and clear errors when the data is invalid.

  438.     * Validation even for deeply nested JSON objects.

  439. * <abbr title="also known as: serialization, parsing, marshalling">Conversion</abbr> of input data: coming from the network to Python data and types. Reading from:

  440.     * JSON.

  441.     * Path parameters.

  442.     * Query parameters.

  443.     * Cookies.

  444.     * Headers.

  445.     * Forms.

  446.     * Files.

  447. * <abbr title="also known as: serialization, parsing, marshalling">Conversion</abbr> of output data: converting from Python data and types to network data (as JSON):

  448.     * Convert Python types (`str`, `int`, `float`, `bool`, `list`, etc).

  449.     * `datetime` objects.

  450.     * `UUID` objects.

  451.     * Database models.

  452.     * ...and many more.

  453. * Automatic interactive API documentation, including 2 alternative user interfaces:

  454.     * Swagger UI.

  455.     * ReDoc.

  456. 

  457. ---

  458. 

  459. Coming back to the previous code example, **FastAPI** will:

  460. 

  461. * Validate that there is an `item_id` in the path for `GET` and `PUT` requests.

  462. * Validate that the `item_id` is of type `int` for `GET` and `PUT` requests.

  463.     * If it is not, the client will see a useful, clear error.

  464. * 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.

  465.     * As the `q` parameter is declared with `= None`, it is optional.

  466.     * Without the `None` it would be required (as is the body in the case with `PUT`).

  467. * For `PUT` requests to `/items/{item_id}`, read the body as JSON:

  468.     * Check that it has a required attribute `name` that should be a `str`.

  469.     * Check that it has a required attribute `price` that has to be a `float`.

  470.     * Check that it has an optional attribute `is_offer`, that should be a `bool`, if present.

  471.     * All this would also work for deeply nested JSON objects.

  472. * Convert from and to JSON automatically.

  473. * Document everything with OpenAPI, that can be used by:

  474.     * Interactive documentation systems.

  475.     * Automatic client code generation systems, for many languages.

  476. * Provide 2 interactive documentation web interfaces directly.

  477. 

  478. ---

  479. 

  480. We just scratched the surface, but you already get the idea of how it all works.

  481. 

  482. Try changing the line with:

  483. 

  484. ```Python

  485.     return {"item_name": item.name, "item_id": item_id}

  486. ```

  487. 

  488. ...from:

  489. 

  490. ```Python

  491.         ... "item_name": item.name ...

  492. ```

  493. 

  494. ...to:

  495. 

  496. ```Python

  497.         ... "item_price": item.price ...

  498. ```

  499. 

  500. ...and see how your editor will auto-complete the attributes and know their types:

  501. 

  502. ![editor support](https://fastapi.tiangolo.com/img/vscode-completion.png)

  503. 

  504. For a more complete example including more features, see the <a href="https://fastapi.tiangolo.com/tutorial/">Tutorial - User Guide</a>.

  505. 

  506. **Spoiler alert**: the tutorial - user guide includes:

  507. 

  508. * Declaration of **parameters** from other different places as: **headers**, **cookies**, **form fields** and **files**.

  509. * How to set **validation constraints** as `maximum_length` or `regex`.

  510. * A very powerful and easy to use **<abbr title="also known as components, resources, providers, services, injectables">Dependency Injection</abbr>** system.

  511. * Security and authentication, including support for **OAuth2** with **JWT tokens** and **HTTP Basic** auth.

  512. * More advanced (but equally easy) techniques for declaring **deeply nested JSON models** (thanks to Pydantic).

  513. * **GraphQL** integration with <a href="https://strawberry.rocks" class="external-link" target="_blank">Strawberry</a> and other libraries.

  514. * Many extra features (thanks to Starlette) as:

  515.     * **WebSockets**

  516.     * extremely easy tests based on HTTPX and `pytest`

  517.     * **CORS**

  518.     * **Cookie Sessions**

  519.     * ...and more.

  520. 

  521. ## Performance

  522. 

  523. 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). (*)

  524. 

  525. To understand more about it, see the section <a href="https://fastapi.tiangolo.com/benchmarks/" class="internal-link" target="_blank">Benchmarks</a>.

  526. 

  527. ## Dependencies

  528. 

  529. FastAPI depends on Pydantic and Starlette.

  530. 

  531. ### `standard` Dependencies

  532. 

  533. When you install FastAPI with `pip install "fastapi[standard]"` it comes with the `standard` group of optional dependencies:

  534. 

  535. Used by Pydantic:

  536. 

  537. * <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email-validator</code></a> - for email validation.

  538. 

  539. Used by Starlette:

  540. 

  541. * <a href="https://www.python-httpx.org" target="_blank"><code>httpx</code></a> - Required if you want to use the `TestClient`.

  542. * <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration.

  543. * <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()`.

  544. 

  545. Used by FastAPI:

  546. 

  547. * <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.

  548. * `fastapi-cli[standard]` - to provide the `fastapi` command.

  549.     * This includes `fastapi-cloud-cli`, which allows you to deploy your FastAPI application to <a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>.

  550. 

  551. ### Without `standard` Dependencies

  552. 

  553. If you don't want to include the `standard` optional dependencies, you can install with `pip install fastapi` instead of `pip install "fastapi[standard]"`.

  554. 

  555. ### Without `fastapi-cloud-cli`

  556. 

  557. 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]"`.

  558. 

  559. ### Additional Optional Dependencies

  560. 

  561. There are some additional dependencies you might want to install.

  562. 

  563. Additional optional Pydantic dependencies:

  564. 

  565. * <a href="https://docs.pydantic.dev/latest/usage/pydantic_settings/" target="_blank"><code>pydantic-settings</code></a> - for settings management.

  566. * <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.

  567. 

  568. Additional optional FastAPI dependencies:

  569. 

  570. * <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`.

  571. * <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.

  572. 

  573. ## License

  574. 

  575. This project is licensed under the terms of the MIT license.