pollutri
/
res_levis_API
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 Commit
1 Branch
203 MiB
 
 
 
 
Tree: 5404e09047
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '5404e09047'
${ noResults }
res_levis_API/lib/python3.6/site-packages/fastapi-0.71.0.dist-info/METADATA

548 lines
24 KiB
Raw Blame History 

  1. Metadata-Version: 2.1

  2. Name: fastapi

  3. Version: 0.71.0

  4. Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production

  5. Home-page: https://github.com/tiangolo/fastapi

  6. Author: Sebastián Ramírez

  7. Author-email: tiangolo@gmail.com

  8. Requires-Python: >=3.6.1

  9. Description-Content-Type: text/markdown

  10. Classifier: Intended Audience :: Information Technology

  11. Classifier: Intended Audience :: System Administrators

  12. Classifier: Operating System :: OS Independent

  13. Classifier: Programming Language :: Python :: 3

  14. Classifier: Programming Language :: Python

  15. Classifier: Topic :: Internet

  16. Classifier: Topic :: Software Development :: Libraries :: Application Frameworks

  17. Classifier: Topic :: Software Development :: Libraries :: Python Modules

  18. Classifier: Topic :: Software Development :: Libraries

  19. Classifier: Topic :: Software Development

  20. Classifier: Typing :: Typed

  21. Classifier: Development Status :: 4 - Beta

  22. Classifier: Environment :: Web Environment

  23. Classifier: Framework :: AsyncIO

  24. Classifier: Framework :: FastAPI

  25. Classifier: Intended Audience :: Developers

  26. Classifier: License :: OSI Approved :: MIT License

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

  28. Classifier: Programming Language :: Python :: 3.6

  29. Classifier: Programming Language :: Python :: 3.7

  30. Classifier: Programming Language :: Python :: 3.8

  31. Classifier: Programming Language :: Python :: 3.9

  32. Classifier: Programming Language :: Python :: 3.10

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

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

  35. Requires-Dist: starlette ==0.17.1

  36. Requires-Dist: pydantic >=1.6.2,!=1.7,!=1.7.1,!=1.7.2,!=1.7.3,!=1.8,!=1.8.1,<2.0.0

  37. Requires-Dist: requests >=2.24.0,<3.0.0 ; extra == "all"

  38. Requires-Dist: jinja2 >=2.11.2,<4.0.0 ; extra == "all"

  39. Requires-Dist: python-multipart >=0.0.5,<0.0.6 ; extra == "all"

  40. Requires-Dist: itsdangerous >=1.1.0,<3.0.0 ; extra == "all"

  41. Requires-Dist: pyyaml >=5.3.1,<6.0.0 ; extra == "all"

  42. Requires-Dist: ujson >=4.0.1,<5.0.0 ; extra == "all"

  43. Requires-Dist: orjson >=3.2.1,<4.0.0 ; extra == "all"

  44. Requires-Dist: email_validator >=1.1.1,<2.0.0 ; extra == "all"

  45. Requires-Dist: uvicorn[standard] >=0.12.0,<0.16.0 ; extra == "all"

  46. Requires-Dist: python-jose[cryptography] >=3.3.0,<4.0.0 ; extra == "dev"

  47. Requires-Dist: passlib[bcrypt] >=1.7.2,<2.0.0 ; extra == "dev"

  48. Requires-Dist: autoflake >=1.4.0,<2.0.0 ; extra == "dev"

  49. Requires-Dist: flake8 >=3.8.3,<4.0.0 ; extra == "dev"

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

  51. Requires-Dist: mkdocs >=1.1.2,<2.0.0 ; extra == "doc"

  52. Requires-Dist: mkdocs-material >=8.1.4,<9.0.0 ; extra == "doc"

  53. Requires-Dist: mdx-include >=1.4.1,<2.0.0 ; extra == "doc"

  54. Requires-Dist: mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0 ; extra == "doc"

  55. Requires-Dist: typer-cli >=0.0.12,<0.0.13 ; extra == "doc"

  56. Requires-Dist: pyyaml >=5.3.1,<6.0.0 ; extra == "doc"

  57. Requires-Dist: pytest >=6.2.4,<7.0.0 ; extra == "test"

  58. Requires-Dist: pytest-cov >=2.12.0,<4.0.0 ; extra == "test"

  59. Requires-Dist: mypy ==0.910 ; extra == "test"

  60. Requires-Dist: flake8 >=3.8.3,<4.0.0 ; extra == "test"

  61. Requires-Dist: black ==21.9b0 ; extra == "test"

  62. Requires-Dist: isort >=5.0.6,<6.0.0 ; extra == "test"

  63. Requires-Dist: requests >=2.24.0,<3.0.0 ; extra == "test"

  64. Requires-Dist: httpx >=0.14.0,<0.19.0 ; extra == "test"

  65. Requires-Dist: email_validator >=1.1.1,<2.0.0 ; extra == "test"

  66. Requires-Dist: sqlalchemy >=1.3.18,<1.5.0 ; extra == "test"

  67. Requires-Dist: peewee >=3.13.3,<4.0.0 ; extra == "test"

  68. Requires-Dist: databases[sqlite] >=0.3.2,<0.6.0 ; extra == "test"

  69. Requires-Dist: orjson >=3.2.1,<4.0.0 ; extra == "test"

  70. Requires-Dist: ujson >=4.0.1,<5.0.0 ; extra == "test"

  71. Requires-Dist: python-multipart >=0.0.5,<0.0.6 ; extra == "test"

  72. Requires-Dist: flask >=1.1.2,<3.0.0 ; extra == "test"

  73. Requires-Dist: anyio[trio] >=3.2.1,<4.0.0 ; extra == "test"

  74. Requires-Dist: types-ujson ==0.1.1 ; extra == "test"

  75. Requires-Dist: types-orjson ==3.6.0 ; extra == "test"

  76. Requires-Dist: types-dataclasses ==0.1.7 ; extra == "test" and ( python_version<'3.7')

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

  78. Provides-Extra: all

  79. Provides-Extra: dev

  80. Provides-Extra: doc

  81. Provides-Extra: test

  82. 

  83. <p align="center">

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

  85. </p>

  86. <p align="center">

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

  88. </p>

  89. <p align="center">

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

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

  92. </a>

  93. <a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank">

  94.     <img src="https://img.shields.io/codecov/c/github/tiangolo/fastapi?color=%2334D058" alt="Coverage">

  95. </a>

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

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

  98. </a>

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

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

  101. </a>

  102. </p>

  103. 

  104. ---

  105. 

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

  107. 

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

  109. 

  110. ---

  111. 

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

  113. 

  114. The key features are:

  115. 

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

  117. 

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

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

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

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

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

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

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

  125. 

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

  127. 

  128. ## Sponsors

  129. 

  130. <!-- sponsors -->

  131. 

  132. <a href="https://bit.ly/2QSouzH" target="_blank" title="Jina: build neural search-as-a-service for any kind of data in just minutes."><img src="https://fastapi.tiangolo.com/img/sponsors/jina.svg"></a>

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

  134. <a href="https://www.deta.sh/?ref=fastapi" target="_blank" title="The launchpad for all your (team's) ideas"><img src="https://fastapi.tiangolo.com/img/sponsors/deta.svg"></a>

  135. <a href="https://www.investsuite.com/jobs" target="_blank" title="Wealthtech jobs with FastAPI"><img src="https://fastapi.tiangolo.com/img/sponsors/investsuite.svg"></a>

  136. <a href="https://www.vim.so/?utm_source=FastAPI" target="_blank" title="We help you master vim with interactive exercises"><img src="https://fastapi.tiangolo.com/img/sponsors/vimso.png"></a>

  137. <a href="https://talkpython.fm/fastapi-sponsor" target="_blank" title="FastAPI video courses on demand from people you trust"><img src="https://fastapi.tiangolo.com/img/sponsors/talkpython.png"></a>

  138. <a href="https://testdriven.io/courses/tdd-fastapi/" target="_blank" title="Learn to build high-quality web apps with best practices"><img src="https://fastapi.tiangolo.com/img/sponsors/testdriven.svg"></a>

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

  140. 

  141. <!-- /sponsors -->

  142. 

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

  144. 

  145. ## Opinions

  146. 

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

  148. 

  149. <div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/tiangolo/fastapi/pull/26" target="_blank"><small>(ref)</small></a></div>

  150. 

  151. ---

  152. 

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

  154. 

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

  156. 

  157. ---

  158. 

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

  160. 

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

  162. 

  163. ---

  164. 

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

  166. 

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

  168. 

  169. ---

  170. 

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

  172. 

  173. <div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="https://www.hug.rest/" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div>

  174. 

  175. ---

  176. 

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

  178. 

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

  180. 

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

  182. 

  183. ---

  184. 

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

  186. 

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

  188. 

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

  190. 

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

  192. 

  193. ## Requirements

  194. 

  195. Python 3.6+

  196. 

  197. FastAPI stands on the shoulders of giants:

  198. 

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

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

  201. 

  202. ## Installation

  203. 

  204. <div class="termy">

  205. 

  206. ```console

  207. $ pip install fastapi

  208. 

  209. ---> 100%

  210. ```

  211. 

  212. </div>

  213. 

  214. You will also need an ASGI server, for production such as <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a> or <a href="https://gitlab.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>.

  215. 

  216. <div class="termy">

  217. 

  218. ```console

  219. $ pip install "uvicorn[standard]"

  220. 

  221. ---> 100%

  222. ```

  223. 

  224. </div>

  225. 

  226. ## Example

  227. 

  228. ### Create it

  229. 

  230. * Create a file `main.py` with:

  231. 

  232. ```Python

  233. from typing import Optional

  234. 

  235. from fastapi import FastAPI

  236. 

  237. app = FastAPI()

  238. 

  239. 

  240. @app.get("/")

  241. def read_root():

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

  243. 

  244. 

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

  246. def read_item(item_id: int, q: Optional[str] = None):

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

  248. ```

  249. 

  250. <details markdown="1">

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

  252. 

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

  254. 

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

  256. from typing import Optional

  257. 

  258. from fastapi import FastAPI

  259. 

  260. app = FastAPI()

  261. 

  262. 

  263. @app.get("/")

  264. async def read_root():

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

  266. 

  267. 

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

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

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

  271. ```

  272. 

  273. **Note**:

  274. 

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

  276. 

  277. </details>

  278. 

  279. ### Run it

  280. 

  281. Run the server with:

  282. 

  283. <div class="termy">

  284. 

  285. ```console

  286. $ uvicorn main:app --reload

  287. 

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

  289. INFO:     Started reloader process [28720]

  290. INFO:     Started server process [28722]

  291. INFO:     Waiting for application startup.

  292. INFO:     Application startup complete.

  293. ```

  294. 

  295. </div>

  296. 

  297. <details markdown="1">

  298. <summary>About the command <code>uvicorn main:app --reload</code>...</summary>

  299. 

  300. The command `uvicorn main:app` refers to:

  301. 

  302. * `main`: the file `main.py` (the Python "module").

  303. * `app`: the object created inside of `main.py` with the line `app = FastAPI()`.

  304. * `--reload`: make the server restart after code changes. Only do this for development.

  305. 

  306. </details>

  307. 

  308. ### Check it

  309. 

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

  311. 

  312. You will see the JSON response as:

  313. 

  314. ```JSON

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

  316. ```

  317. 

  318. You already created an API that:

  319. 

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

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

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

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

  324. 

  325. ### Interactive API docs

  326. 

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

  328. 

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

  330. 

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

  332. 

  333. ### Alternative API docs

  334. 

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

  336. 

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

  338. 

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

  340. 

  341. ## Example upgrade

  342. 

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

  344. 

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

  346. 

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

  348. from typing import Optional

  349. 

  350. from fastapi import FastAPI

  351. from pydantic import BaseModel

  352. 

  353. app = FastAPI()

  354. 

  355. 

  356. class Item(BaseModel):

  357.     name: str

  358.     price: float

  359.     is_offer: Optional[bool] = None

  360. 

  361. 

  362. @app.get("/")

  363. def read_root():

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

  365. 

  366. 

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

  368. def read_item(item_id: int, q: Optional[str] = None):

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

  370. 

  371. 

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

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

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

  375. ```

  376. 

  377. The server should reload automatically (because you added `--reload` to the `uvicorn` command above).

  378. 

  379. ### Interactive API docs upgrade

  380. 

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

  382. 

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

  384. 

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

  386. 

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

  388. 

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

  390. 

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

  392. 

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

  394. 

  395. ### Alternative API docs upgrade

  396. 

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

  398. 

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

  400. 

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

  402. 

  403. ### Recap

  404. 

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

  406. 

  407. You do that with standard modern Python types.

  408. 

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

  410. 

  411. Just standard **Python 3.6+**.

  412. 

  413. For example, for an `int`:

  414. 

  415. ```Python

  416. item_id: int

  417. ```

  418. 

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

  420. 

  421. ```Python

  422. item: Item

  423. ```

  424. 

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

  426. 

  427. * Editor support, including:

  428.     * Completion.

  429.     * Type checks.

  430. * Validation of data:

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

  432.     * Validation even for deeply nested JSON objects.

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

  434.     * JSON.

  435.     * Path parameters.

  436.     * Query parameters.

  437.     * Cookies.

  438.     * Headers.

  439.     * Forms.

  440.     * Files.

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

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

  443.     * `datetime` objects.

  444.     * `UUID` objects.

  445.     * Database models.

  446.     * ...and many more.

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

  448.     * Swagger UI.

  449.     * ReDoc.

  450. 

  451. ---

  452. 

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

  454. 

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

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

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

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

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

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

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

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

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

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

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

  466. * Convert from and to JSON automatically.

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

  468.     * Interactive documentation systems.

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

  470. * Provide 2 interactive documentation web interfaces directly.

  471. 

  472. ---

  473. 

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

  475. 

  476. Try changing the line with:

  477. 

  478. ```Python

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

  480. ```

  481. 

  482. ...from:

  483. 

  484. ```Python

  485.         ... "item_name": item.name ...

  486. ```

  487. 

  488. ...to:

  489. 

  490. ```Python

  491.         ... "item_price": item.price ...

  492. ```

  493. 

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

  495. 

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

  497. 

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

  499. 

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

  501. 

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

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

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

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

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

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

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

  509.     * **WebSockets**

  510.     * extremely easy tests based on `requests` and `pytest`

  511.     * **CORS**

  512.     * **Cookie Sessions**

  513.     * ...and more.

  514. 

  515. ## Performance

  516. 

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

  518. 

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

  520. 

  521. ## Optional Dependencies

  522. 

  523. Used by Pydantic:

  524. 

  525. * <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - for faster JSON <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>.

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

  527. 

  528. Used by Starlette:

  529. 

  530. * <a href="https://requests.readthedocs.io" target="_blank"><code>requests</code></a> - Required if you want to use the `TestClient`.

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

  532. * <a href="https://andrew-d.github.io/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()`.

  533. * <a href="https://pythonhosted.org/itsdangerous/" target="_blank"><code>itsdangerous</code></a> - Required for `SessionMiddleware` support.

  534. * <a href="https://pyyaml.org/wiki/PyYAMLDocumentation" target="_blank"><code>pyyaml</code></a> - Required for Starlette's `SchemaGenerator` support (you probably don't need it with FastAPI).

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

  536. 

  537. Used by FastAPI / Starlette:

  538. 

  539. * <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.

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

  541. 

  542. You can install all of these with `pip install "fastapi[all]"`.

  543. 

  544. ## License

  545. 

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