mirror of https://github.com/tiangolo/fastapi.git
560 lines
23 KiB
Markdown
560 lines
23 KiB
Markdown
# FastAPI { #fastapi }
|
||
|
||
<style>
|
||
.md-content .md-typeset h1 { display: none; }
|
||
</style>
|
||
|
||
<p align="center">
|
||
<a href="https://fastapi.tiangolo.com/zh"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI"></a>
|
||
</p>
|
||
<p align="center">
|
||
<em>FastAPI 框架，高性能，易于学习，高效编码，生产可用</em>
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://github.com/fastapi/fastapi/actions?query=workflow%3ATest+event%3Apush+branch%3Amaster" target="_blank">
|
||
<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" target="_blank">
|
||
<img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/fastapi.svg" alt="Coverage">
|
||
</a>
|
||
<a href="https://pypi.org/project/fastapi" target="_blank">
|
||
<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" target="_blank">
|
||
<img src="https://img.shields.io/pypi/pyversions/fastapi.svg?color=%2334D058" alt="Supported Python versions">
|
||
</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
**文档**： <a href="https://fastapi.tiangolo.com/zh" target="_blank">https://fastapi.tiangolo.com</a>
|
||
|
||
**源码**： <a href="https://github.com/fastapi/fastapi" target="_blank">https://github.com/fastapi/fastapi</a>
|
||
|
||
---
|
||
|
||
FastAPI 是一个用于构建 API 的现代、快速（高性能）的 Web 框架，使用 Python 并基于标准的 Python 类型提示。
|
||
|
||
关键特性：
|
||
|
||
* **快速**：极高性能，可与 **NodeJS** 和 **Go** 并肩（归功于 Starlette 和 Pydantic）。[最快的 Python 框架之一](#performance)。
|
||
* **高效编码**：功能开发速度提升约 200% ～ 300%。*
|
||
* **更少 bug**：人为（开发者）错误减少约 40%。*
|
||
* **直观**：极佳的编辑器支持。处处皆可<dfn title="也被称为：自动完成、自动补全、IntelliSense">自动补全</dfn>。更少的调试时间。
|
||
* **易用**：为易用和易学而设计。更少的文档阅读时间。
|
||
* **简短**：最小化代码重复。一次参数声明即可获得多种功能。更少的 bug。
|
||
* **健壮**：生产可用级代码。并带有自动生成的交互式文档。
|
||
* **标准化**：基于（并完全兼容）API 的开放标准：<a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a>（以前称为 Swagger）和 <a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>。
|
||
|
||
<small>* 基于某内部开发团队在构建生产应用时的测试估算。</small>
|
||
|
||
## 赞助商 { #sponsors }
|
||
|
||
<!-- sponsors -->
|
||
|
||
### Keystone 赞助商 { #keystone-sponsor }
|
||
|
||
{% for sponsor in sponsors.keystone -%}
|
||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
||
{% endfor -%}
|
||
|
||
### 金牌和银牌赞助商 { #gold-and-silver-sponsors }
|
||
|
||
{% for sponsor in sponsors.gold -%}
|
||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
||
{% endfor -%}
|
||
{%- for sponsor in sponsors.silver -%}
|
||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a>
|
||
{% endfor %}
|
||
|
||
<!-- /sponsors -->
|
||
|
||
<a href="https://fastapi.tiangolo.com/zh/fastapi-people/#sponsors" class="external-link" target="_blank">其他赞助商</a>
|
||
|
||
## 评价 { #opinions }
|
||
|
||
「_[...] 最近我大量使用 **FastAPI**。[...] 我实际上计划把它用于我团队在 **微软** 的所有 **机器学习服务**。其中一些正在集成进核心 **Windows** 产品以及一些 **Office** 产品。_」
|
||
|
||
<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>
|
||
|
||
---
|
||
|
||
「_我们采用 **FastAPI** 来构建可查询以获取**预测结果**的 **REST** 服务器。[用于 Ludwig]_」
|
||
|
||
<div style="text-align: right; margin-right: 10%;">Piero Molino，Yaroslav Dudin，Sai Sumanth Miryala - <strong>Uber</strong> <a href="https://eng.uber.com/ludwig-v0-2/" target="_blank"><small>(ref)</small></a></div>
|
||
|
||
---
|
||
|
||
「_**Netflix** 很高兴宣布开源我们的**危机管理**编排框架：**Dispatch**！[使用 **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" target="_blank"><small>(ref)</small></a></div>
|
||
|
||
---
|
||
|
||
「_我对 **FastAPI** 兴奋到飞起。它太有趣了！_」
|
||
|
||
<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> 播客主持人</strong> <a href="https://x.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div>
|
||
|
||
---
|
||
|
||
「_老实说，你构建的东西非常稳健而且打磨得很好。从很多方面看，这就是我想让 **Hug** 成为的样子 —— 看到有人把它做出来真的很鼓舞人心。_」
|
||
|
||
<div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="https://github.com/hugapi/hug" target="_blank">Hug</a> 作者</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div>
|
||
|
||
---
|
||
|
||
「_如果你想学一个用于构建 REST API 的**现代框架**，看看 **FastAPI** [...] 它快速、易用且易学 [...]_」
|
||
|
||
「_我们已经把我们的 **API** 切换到 **FastAPI** [...] 我想你会喜欢它 [...]_」
|
||
|
||
<div style="text-align: right; margin-right: 10%;">Ines Montani - Matthew Honnibal - <strong><a href="https://explosion.ai" target="_blank">Explosion AI</a> 创始人 - <a href="https://spacy.io" target="_blank">spaCy</a> 作者</strong> <a href="https://x.com/_inesmontani/status/1144173225322143744" target="_blank"><small>(ref)</small></a> - <a href="https://x.com/honnibal/status/1144031421859655680" target="_blank"><small>(ref)</small></a></div>
|
||
|
||
---
|
||
|
||
「_如果有人正在构建生产级的 Python API，我强烈推荐 **FastAPI**。它**设计优雅**、**使用简单**且**高度可扩展**，已经成为我们 API 优先开发战略中的**关键组件**，并驱动了许多自动化和服务，比如我们的 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/" target="_blank"><small>(ref)</small></a></div>
|
||
|
||
---
|
||
|
||
## FastAPI 迷你纪录片 { #fastapi-mini-documentary }
|
||
|
||
在 2025 年末发布了一部<a href="https://www.youtube.com/watch?v=mpR8ngthqiE" class="external-link" target="_blank">FastAPI 迷你纪录片</a>，你可以在线观看：
|
||
|
||
<a href="https://www.youtube.com/watch?v=mpR8ngthqiE" target="_blank"><img src="https://fastapi.tiangolo.com/img/fastapi-documentary.jpg" alt="FastAPI Mini Documentary"></a>
|
||
|
||
## **Typer**，命令行中的 FastAPI { #typer-the-fastapi-of-clis }
|
||
|
||
<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>
|
||
|
||
如果你要开发一个用于终端的 <abbr title="Command Line Interface">命令行</abbr>应用而不是 Web API，看看 <a href="https://typer.tiangolo.com/" class="external-link" target="_blank">**Typer**</a>。
|
||
|
||
**Typer** 是 FastAPI 的小同胞。它的目标是成为**命令行中的 FastAPI**。⌨️ 🚀
|
||
|
||
## 依赖 { #requirements }
|
||
|
||
FastAPI 站在巨人的肩膀之上：
|
||
|
||
* <a href="https://www.starlette.dev/" class="external-link" target="_blank">Starlette</a> 负责 Web 部分。
|
||
* <a href="https://docs.pydantic.dev/" class="external-link" target="_blank">Pydantic</a> 负责数据部分。
|
||
|
||
## 安装 { #installation }
|
||
|
||
创建并激活一个<a href="https://fastapi.tiangolo.com/zh/virtual-environments/" class="external-link" target="_blank">虚拟环境</a>，然后安装 FastAPI：
|
||
|
||
<div class="termy">
|
||
|
||
```console
|
||
$ pip install "fastapi[standard]"
|
||
|
||
---> 100%
|
||
```
|
||
|
||
</div>
|
||
|
||
**Note**: 请确保把 `"fastapi[standard]"` 用引号包起来，以保证在所有终端中都能正常工作。
|
||
|
||
## 示例 { #example }
|
||
|
||
### 创建 { #create-it }
|
||
|
||
创建文件 `main.py`，内容如下：
|
||
|
||
```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>或者使用 <code>async def</code>...</summary>
|
||
|
||
如果你的代码里会用到 `async` / `await`，请使用 `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**:
|
||
|
||
如果你不确定，请查看文档中 _"In a hurry?"_ 章节的<a href="https://fastapi.tiangolo.com/zh/async/#in-a-hurry" target="_blank">`async` 和 `await`</a>部分。
|
||
|
||
</details>
|
||
|
||
### 运行 { #run-it }
|
||
|
||
用下面的命令运行服务器：
|
||
|
||
<div class="termy">
|
||
|
||
```console
|
||
$ fastapi dev main.py
|
||
|
||
╭────────── 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>关于命令 <code>fastapi dev main.py</code>...</summary>
|
||
|
||
`fastapi dev` 命令会读取你的 `main.py` 文件，检测其中的 **FastAPI** 应用，并使用 <a href="https://www.uvicorn.dev" class="external-link" target="_blank">Uvicorn</a> 启动服务器。
|
||
|
||
默认情况下，`fastapi dev` 会在本地开发时启用自动重载。
|
||
|
||
你可以在 <a href="https://fastapi.tiangolo.com/zh/fastapi-cli/" target="_blank">FastAPI CLI 文档</a>中了解更多。
|
||
|
||
</details>
|
||
|
||
### 检查 { #check-it }
|
||
|
||
用浏览器打开 <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>。
|
||
|
||
你会看到如下 JSON 响应：
|
||
|
||
```JSON
|
||
{"item_id": 5, "q": "somequery"}
|
||
```
|
||
|
||
你已经创建了一个 API，它可以：
|
||
|
||
* 在路径 `/` 和 `/items/{item_id}` 接收 HTTP 请求。
|
||
* 以上两个路径都接受 `GET` <em>操作</em>（也称为 HTTP <em>方法</em>）。
|
||
* 路径 `/items/{item_id}` 有一个应为 `int` 的<em>路径参数</em> `item_id`。
|
||
* 路径 `/items/{item_id}` 有一个可选的 `str` 类型<em>查询参数</em> `q`。
|
||
|
||
### 交互式 API 文档 { #interactive-api-docs }
|
||
|
||
现在访问 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>。
|
||
|
||
你会看到自动生成的交互式 API 文档（由 <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a> 提供）：
|
||
|
||
|
||
|
||
### 可选的 API 文档 { #alternative-api-docs }
|
||
|
||
然后访问 <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>。
|
||
|
||
你会看到另一个自动生成的文档（由 <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a> 提供）：
|
||
|
||
|
||
|
||
## 示例升级 { #example-upgrade }
|
||
|
||
现在修改 `main.py` 文件来接收来自 `PUT` 请求的请求体。
|
||
|
||
借助 Pydantic，使用标准的 Python 类型来声明请求体。
|
||
|
||
```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}
|
||
```
|
||
|
||
`fastapi dev` 服务器会自动重载。
|
||
|
||
### 交互式 API 文档升级 { #interactive-api-docs-upgrade }
|
||
|
||
现在访问 <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>。
|
||
|
||
* 交互式 API 文档会自动更新，并包含新的请求体：
|
||
|
||
|
||
|
||
* 点击「Try it out」按钮，它允许你填写参数并直接与 API 交互：
|
||
|
||
|
||
|
||
* 然后点击「Execute」按钮，界面会与你的 API 通信、发送参数、获取结果并在屏幕上展示：
|
||
|
||
|
||
|
||
### 可选文档升级 { #alternative-api-docs-upgrade }
|
||
|
||
再访问 <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>。
|
||
|
||
* 可选文档同样会体现新的查询参数和请求体：
|
||
|
||
|
||
|
||
### 总结 { #recap }
|
||
|
||
总之，你只需要把参数、请求体等的类型作为函数参数**声明一次**。
|
||
|
||
这些都使用标准的现代 Python 类型即可。
|
||
|
||
你不需要学习新的语法、某个特定库的方法或类等。
|
||
|
||
只需要标准的 **Python**。
|
||
|
||
例如，一个 `int`：
|
||
|
||
```Python
|
||
item_id: int
|
||
```
|
||
|
||
或者更复杂的 `Item` 模型：
|
||
|
||
```Python
|
||
item: Item
|
||
```
|
||
|
||
……通过一次声明，你将获得：
|
||
|
||
* 编辑器支持，包括：
|
||
* 自动补全。
|
||
* 类型检查。
|
||
* 数据校验：
|
||
* 当数据无效时自动生成清晰的错误信息。
|
||
* 即便是多层嵌套的 JSON 对象也会进行校验。
|
||
* <dfn title="也被称为：序列化、解析、编组">转换</dfn>输入数据：从网络读取到 Python 数据和类型。读取来源：
|
||
* JSON。
|
||
* 路径参数。
|
||
* 查询参数。
|
||
* Cookies。
|
||
* Headers。
|
||
* Forms。
|
||
* Files。
|
||
* <dfn title="也被称为：序列化、解析、编组">转换</dfn>输出数据：从 Python 数据和类型转换为网络数据（JSON）：
|
||
* 转换 Python 类型（`str`、`int`、`float`、`bool`、`list` 等）。
|
||
* `datetime` 对象。
|
||
* `UUID` 对象。
|
||
* 数据库模型。
|
||
* ……以及更多。
|
||
* 自动生成的交互式 API 文档，包括两种可选的用户界面：
|
||
* Swagger UI。
|
||
* ReDoc。
|
||
|
||
---
|
||
|
||
回到之前的代码示例，**FastAPI** 将会：
|
||
|
||
* 校验 `GET` 和 `PUT` 请求的路径中是否包含 `item_id`。
|
||
* 校验 `GET` 和 `PUT` 请求中的 `item_id` 是否为 `int` 类型。
|
||
* 如果不是，客户端会看到清晰有用的错误信息。
|
||
* 对于 `GET` 请求，检查是否存在名为 `q` 的可选查询参数（如 `http://127.0.0.1:8000/items/foo?q=somequery`）。
|
||
* 因为参数 `q` 被声明为 `= None`，所以它是可选的。
|
||
* 如果没有 `None`，它就是必需的（就像 `PUT` 情况下的请求体）。
|
||
* 对于发送到 `/items/{item_id}` 的 `PUT` 请求，把请求体作为 JSON 读取：
|
||
* 检查是否存在必需属性 `name`，且为 `str`。
|
||
* 检查是否存在必需属性 `price`，且为 `float`。
|
||
* 检查是否存在可选属性 `is_offer`，如果存在则应为 `bool`。
|
||
* 对于多层嵌套的 JSON 对象，同样适用。
|
||
* 自动完成 JSON 的读取与输出转换。
|
||
* 使用 OpenAPI 记录所有内容，可用于：
|
||
* 交互式文档系统。
|
||
* 多语言的客户端代码自动生成系统。
|
||
* 直接提供 2 种交互式文档 Web 界面。
|
||
|
||
---
|
||
|
||
我们只是浅尝辄止，但你已经大致了解其工作方式了。
|
||
|
||
尝试把这一行：
|
||
|
||
```Python
|
||
return {"item_name": item.name, "item_id": item_id}
|
||
```
|
||
|
||
……从：
|
||
|
||
```Python
|
||
... "item_name": item.name ...
|
||
```
|
||
|
||
……改为：
|
||
|
||
```Python
|
||
... "item_price": item.price ...
|
||
```
|
||
|
||
……看看你的编辑器如何自动补全属性并知道它们的类型：
|
||
|
||
|
||
|
||
更多包含更多特性的完整示例，请参阅 <a href="https://fastapi.tiangolo.com/zh/tutorial/">教程 - 用户指南</a>。
|
||
|
||
**剧透警告**：教程 - 用户指南包括：
|
||
|
||
* 来自不同位置的**参数**声明：**headers**、**cookies**、**form 字段**和**文件**。
|
||
* 如何设置**校验约束**，如 `maximum_length` 或 `regex`。
|
||
* 功能强大且易用的 **<dfn title="也被称为：组件、资源、提供者、服务、可注入项">依赖注入</dfn>** 系统。
|
||
* 安全与认证，包括对 **OAuth2**、**JWT tokens** 和 **HTTP Basic** 认证的支持。
|
||
* 更高级（但同样简单）的 **多层嵌套 JSON 模型** 声明技巧（得益于 Pydantic）。
|
||
* 通过 <a href="https://strawberry.rocks" class="external-link" target="_blank">Strawberry</a> 等库进行 **GraphQL** 集成。
|
||
* 许多额外特性（归功于 Starlette），例如：
|
||
* **WebSockets**
|
||
* 基于 HTTPX 和 `pytest` 的极其简单的测试
|
||
* **CORS**
|
||
* **Cookie Sessions**
|
||
* ……以及更多。
|
||
|
||
### 部署你的应用（可选） { #deploy-your-app-optional }
|
||
|
||
你可以选择把 FastAPI 应用部署到 <a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>，如果还没有的话去加入候补名单吧。🚀
|
||
|
||
如果你已经有 **FastAPI Cloud** 账号（我们从候补名单邀请了你 😉），你可以用一个命令部署你的应用。
|
||
|
||
部署前，先确认已登录：
|
||
|
||
<div class="termy">
|
||
|
||
```console
|
||
$ fastapi login
|
||
|
||
You are logged in to FastAPI Cloud 🚀
|
||
```
|
||
|
||
</div>
|
||
|
||
然后部署你的应用：
|
||
|
||
<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>
|
||
|
||
就这样！现在你可以通过该 URL 访问你的应用了。✨
|
||
|
||
#### 关于 FastAPI Cloud { #about-fastapi-cloud }
|
||
|
||
**<a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>** 由 **FastAPI** 的同一位作者和团队打造。
|
||
|
||
它让你以最小的工作量就能**构建**、**部署**并**访问**一个 API。
|
||
|
||
它把用 FastAPI 构建应用时的**开发者体验**带到了部署到云上的过程。🎉
|
||
|
||
FastAPI Cloud 是「FastAPI and friends」开源项目的主要赞助方和资金提供者。✨
|
||
|
||
#### 部署到其他云厂商 { #deploy-to-other-cloud-providers }
|
||
|
||
FastAPI 是开源且基于标准的。你可以部署 FastAPI 应用到你选择的任意云厂商。
|
||
|
||
按照你的云厂商的指南部署 FastAPI 应用即可。🤓
|
||
|
||
## 性能 { #performance }
|
||
|
||
独立机构 TechEmpower 的基准测试显示，运行在 Uvicorn 下的 **FastAPI** 应用是<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">最快的 Python 框架之一</a>，仅次于 Starlette 和 Uvicorn 本身（FastAPI 内部使用它们）。(*)
|
||
|
||
想了解更多，请参阅<a href="https://fastapi.tiangolo.com/zh/benchmarks/" class="internal-link" target="_blank">基准测试</a>章节。
|
||
|
||
## 依赖项 { #dependencies }
|
||
|
||
FastAPI 依赖 Pydantic 和 Starlette。
|
||
|
||
### `standard` 依赖 { #standard-dependencies }
|
||
|
||
当你通过 `pip install "fastapi[standard]"` 安装 FastAPI 时，会包含 `standard` 组的一些可选依赖：
|
||
|
||
Pydantic 使用：
|
||
|
||
* <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email-validator</code></a> - 用于 email 校验。
|
||
|
||
Starlette 使用：
|
||
|
||
* <a href="https://www.python-httpx.org" target="_blank"><code>httpx</code></a> - 使用 `TestClient` 时需要。
|
||
* <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - 使用默认模板配置时需要。
|
||
* <a href="https://github.com/Kludex/python-multipart" target="_blank"><code>python-multipart</code></a> - 使用 `request.form()` 支持表单<dfn title="将 HTTP 请求中的字符串转换为 Python 数据">「解析」</dfn>时需要。
|
||
|
||
FastAPI 使用：
|
||
|
||
* <a href="https://www.uvicorn.dev" target="_blank"><code>uvicorn</code></a> - 加载并提供你的应用的服务器。包含 `uvicorn[standard]`，其中包含高性能服务所需的一些依赖（例如 `uvloop`）。
|
||
* `fastapi-cli[standard]` - 提供 `fastapi` 命令。
|
||
* 其中包含 `fastapi-cloud-cli`，它允许你将 FastAPI 应用部署到 <a href="https://fastapicloud.com" class="external-link" target="_blank">FastAPI Cloud</a>。
|
||
|
||
### 不包含 `standard` 依赖 { #without-standard-dependencies }
|
||
|
||
如果你不想包含这些 `standard` 可选依赖，可以使用 `pip install fastapi`，而不是 `pip install "fastapi[standard]"`。
|
||
|
||
### 不包含 `fastapi-cloud-cli` { #without-fastapi-cloud-cli }
|
||
|
||
如果你想安装带有 standard 依赖但不包含 `fastapi-cloud-cli` 的 FastAPI，可以使用 `pip install "fastapi[standard-no-fastapi-cloud-cli]"`。
|
||
|
||
### 其他可选依赖 { #additional-optional-dependencies }
|
||
|
||
还有一些你可能想安装的可选依赖。
|
||
|
||
额外的 Pydantic 可选依赖：
|
||
|
||
* <a href="https://docs.pydantic.dev/latest/usage/pydantic_settings/" target="_blank"><code>pydantic-settings</code></a> - 用于配置管理。
|
||
* <a href="https://docs.pydantic.dev/latest/usage/types/extra_types/extra_types/" target="_blank"><code>pydantic-extra-types</code></a> - 用于在 Pydantic 中使用的额外类型。
|
||
|
||
额外的 FastAPI 可选依赖：
|
||
|
||
* <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - 使用 `ORJSONResponse` 时需要。
|
||
* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - 使用 `UJSONResponse` 时需要。
|
||
|
||
## 许可协议 { #license }
|
||
|
||
该项目遵循 MIT 许可协议。
|