FastAPI¶
FastAPI 框架，高性能，易于学习，编码快速，生产就绪。
源代码: https://github.com/fastapi/fastapi
FastAPI 是一个现代、快速（高性能）的 Web 框架，用于基于标准 Python 类型提示构建 API。
主要特性包括：
- 快速：极高的性能，与 NodeJS 和 Go 不相上下（得益于 Starlette 和 Pydantic）。它是目前最快的 Python 框架之一。
- 编码快速：功能开发速度提高约 200% 到 300%。*
- 更少 Bug：减少约 40% 的人为（开发者）错误。*
- 直观：出色的编辑器支持。补全无处不在。调试时间更少。
- 简单：设计为易于使用和学习。阅读文档时间更少。
- 简洁：最小化代码重复。每个参数声明实现多个功能。减少 Bug。
- 健壮：获得生产就绪代码。带有自动交互式文档。
- 基于标准：基于（并完全兼容）API 的开放标准：OpenAPI（以前称为 Swagger）和 JSON Schema。
* 根据内部开发团队构建生产应用程序的测试估算。
赞助商¶
评价¶
"[...] 我最近大量使用 FastAPI。[...] 我实际上计划在 Microsoft 的所有 ML 服务中使用它。其中一些将集成到核心 Windows 产品和一些 Office 产品中。"
"我们采用 FastAPI 库来启动一个 REST 服务器，该服务器可以被查询以获取预测。[用于 Ludwig]"
"Netflix 很高兴宣布开源我们的危机管理编排框架：Dispatch！[使用 FastAPI 构建]"
"我对 FastAPI 激动万分。它太有趣了！"
"老实说，你构建的东西看起来非常扎实和完善。在许多方面，这就是我希望 Hug 成为的样子——看到有人构建出这样的东西真是令人振奋。"
"如果你正在学习一个现代框架来构建 REST API，那就看看 FastAPI [...] 它快速、易用且易学 [...]"
"我们的 API 已经切换到 FastAPI [...] 我想你会喜欢它的 [...]"
"如果有人想构建生产级别的 Python API，我强烈推荐 FastAPI。它设计精美、使用简单且高度可扩展，它已成为我们 API 优先开发策略的关键组成部分，并驱动着许多自动化和服务，例如我们的虚拟 TAC 工程师。"
Typer，命令行应用的 FastAPI¶
如果你正在构建一个用于终端而非 Web API 的CLI 应用，请查看 Typer。
Typer 是 FastAPI 的小兄弟。它旨在成为命令行应用的 FastAPI。⌨️ 🚀
要求¶
FastAPI 站在巨人的肩膀上
安装¶
创建并激活虚拟环境，然后安装 FastAPI
$ pip install "fastapi[standard]"
---> 100%
注意：请务必将 "fastapi[standard]" 用引号括起来，以确保它在所有终端中都能正常工作。
示例¶
创建¶
创建文件 main.py，内容如下：
from typing import Union
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: Union[str, None] = None):
return {"item_id": item_id, "q": q}
或使用 async def...
如果你的代码使用 async / await，请使用 async def
from typing import Union
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: Union[str, None] = None):
return {"item_id": item_id, "q": q}
注意:
如果你不确定，请查看文档中关于 async 和 await 的“快速入门”部分。
运行¶
使用以下命令运行服务器：
$ 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.
关于命令 fastapi dev main.py...
命令 fastapi dev 读取你的 main.py 文件，检测其中的 FastAPI 应用程序，并使用 Uvicorn 启动服务器。
默认情况下，fastapi dev 将在本地开发时启用自动重载。
你可以在 FastAPI CLI 文档中了解更多信息。
检查它¶
在浏览器中打开 http://127.0.0.1:8000/items/5?q=somequery。
你将看到以下 JSON 响应：
{"item_id": 5, "q": "somequery"}
你已经创建了一个 API，它：
- 在路径
/和/items/{item_id}接收 HTTP 请求。 - 这两个路径都接受
GET操作（也称为 HTTP 方法）。 - 路径
/items/{item_id}有一个路径参数item_id，它应该是int类型。 - 路径
/items/{item_id}有一个可选的str查询参数q。
交互式 API 文档¶
现在访问 http://127.0.0.1:8000/docs。
你将看到自动生成的交互式 API 文档（由 Swagger UI 提供）
备选 API 文档¶
现在，访问 http://127.0.0.1:8000/redoc。
你将看到备选的自动文档（由 ReDoc 提供）
示例升级¶
现在修改文件 main.py，以接收来自 PUT 请求的正文。
借助 Pydantic，使用标准 Python 类型声明正文。
from typing import Union
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str
price: float
is_offer: Union[bool, None] = None
@app.get("/")
def read_root():
return {"Hello": "World"}
@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[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 文档升级¶
现在访问 http://127.0.0.1:8000/docs。
- 交互式 API 文档将自动更新，包括新的正文
- 点击“试用”按钮，你可以填写参数并直接与 API 交互
- 然后点击“执行”按钮，用户界面将与你的 API 通信，发送参数，获取结果并将其显示在屏幕上
备选 API 文档升级¶
现在，访问 http://127.0.0.1:8000/redoc。
- 备选文档也将反映新的查询参数和正文
总结¶
总之，你只需在函数参数中一次性声明参数、正文等的类型。
你使用标准现代 Python 类型来完成此操作。
你无需学习新的语法、特定库的方法或类等。
只需标准 Python。
例如，对于 int
item_id: int
或者对于更复杂的 Item 模型
item: Item
...通过这个单一声明，你将获得：
- 编辑器支持，包括：
- 补全。
- 类型检查。
- 数据验证
- 数据无效时自动且清晰的错误提示。
- 即使是深层嵌套的 JSON 对象也能进行验证。
- 输入数据转换：将来自网络的数据转换为 Python 数据和类型。读取自：
- JSON。
- 路径参数。
- 查询参数。
- Cookie。
- 请求头。
- 表单。
- 文件。
- 输出数据转换：将 Python 数据和类型转换为网络数据（如 JSON）
- 转换 Python 类型（
str、int、float、bool、list等）。 datetime对象。UUID对象。- 数据库模型。
- ...以及更多。
- 转换 Python 类型（
- 自动交互式 API 文档，包括 2 种备选用户界面：
- 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请求中的正文一样）。
- 由于
- 对于
PUT请求到/items/{item_id}，将正文读取为 JSON- 检查它是否有一个必需属性
name，该属性应为str。 - 检查它是否有一个必需属性
price，该属性必须为float。 - 检查它是否有一个可选属性
is_offer，如果存在，则应为bool。 - 所有这些也适用于深层嵌套的 JSON 对象。
- 检查它是否有一个必需属性
- 自动进行 JSON 的转换。
- 使用 OpenAPI 文档化所有内容，可用于：
- 交互式文档系统。
- 多种语言的自动客户端代码生成系统。
- 直接提供 2 个交互式文档 Web 界面。
我们只是浅尝辄止，但你已经了解了它的工作原理。
尝试更改以下行：
return {"item_name": item.name, "item_id": item_id}
...从
... "item_name": item.name ...
...到
... "item_price": item.price ...
...然后看看你的编辑器如何自动补全属性并识别它们的类型
要查看包含更多功能的完整示例，请参阅教程 - 用户指南。
剧透警告：教程 - 用户指南包括：
- 声明来自其他不同位置的参数，例如：headers、cookies、form fields 和 files。
- 如何设置验证约束，例如
maximum_length或regex。 - 一个功能强大且易于使用的依赖注入系统。
- 安全和认证，包括支持带 JWT token 的 OAuth2 和 HTTP Basic 认证。
- 更高级（但同样简单）的声明深层嵌套 JSON 模型的技术（得益于 Pydantic）。
- 与 Strawberry 及其他库的 GraphQL 集成。
- 许多额外功能（得益于 Starlette），例如：
- WebSockets
- 基于 HTTPX 和
pytest的极简测试 - CORS
- Cookie 会话
- ...等等。
性能¶
独立的 TechEmpower 基准测试显示，在 Uvicorn 下运行的 FastAPI 应用程序是最快的 Python 框架之一，仅次于 Starlette 和 Uvicorn 本身（FastAPI 内部使用它们）。(*)
要了解更多信息，请参阅基准测试部分。
依赖项¶
FastAPI 依赖于 Pydantic 和 Starlette。
standard 依赖项¶
当你使用 pip install "fastapi[standard]" 安装 FastAPI 时，它会附带 standard 组可选依赖项：
Pydantic 使用：
email-validator- 用于电子邮件验证。
Starlette 使用：
httpx- 如果你想使用TestClient，则必需。jinja2- 如果你想使用默认模板配置，则必需。python-multipart- 如果你想支持带有request.form()的表单“解析”，则必需。
FastAPI 使用：
uvicorn- 用于加载和提供应用程序的服务器。这包括uvicorn[standard]，它包含高性能服务所需的一些依赖项（例如uvloop）。fastapi-cli[standard]- 用于提供fastapi命令。- 这包括
fastapi-cloud-cli，它允许你将 FastAPI 应用程序部署到 FastAPI Cloud。
- 这包括
不带 standard 依赖项¶
如果你不想包含 standard 可选依赖项，可以使用 pip install fastapi 代替 pip install "fastapi[standard]"。
不带 fastapi-cloud-cli¶
如果你想安装带标准依赖项但没有 fastapi-cloud-cli 的 FastAPI，可以使用 pip install "fastapi[standard-no-fastapi-cloud-cli]" 进行安装。
其他可选依赖项¶
你可能需要安装一些额外的依赖项。
Pydantic 其他可选依赖项
pydantic-settings- 用于设置管理。pydantic-extra-types- 用于 Pydantic 的额外类型。
FastAPI 其他可选依赖项
许可证¶
本项目根据 MIT 许可证条款获得许可。