FastAPI¶
FastAPI 框架，高性能，易于学习，快速编码，可用于生产
源代码：https://github.com/fastapi/fastapi
FastAPI 是一个现代、快速（高性能）的 Web 框架，用于基于标准 Python 类型提示使用 Python 构建 API。
主要特性如下：
- 快速：非常高的性能，与 NodeJS 和 Go 相当（归功于 Starlette 和 Pydantic）。现有最快的 Python 框架之一。
- 编码快速：将开发功能的速度提高约 200% 到 300%。*
- 更少 Bug：减少约 40% 的人为（开发者）导致的错误。*
- 直观：强大的编辑器支持。代码补全 无处不在。减少调试时间。
- 简单：设计得易于使用和学习。减少阅读文档的时间。
- 简短：最大限度地减少代码重复。每个参数声明都具有多种功能。更少 Bug。
- 健壮：获得可用于生产的代码。带有自动交互式文档。
- 基于标准：基于（并完全兼容）API 的开放标准：OpenAPI（以前称为 Swagger）和 JSON Schema。
* 基于内部开发团队构建生产应用程序的测试估算。
赞助商¶
基石赞助商¶
金牌和银牌赞助商¶
评价¶
“[...] 我最近大量使用 FastAPI。[...] 我实际上计划将其用于微软我团队的所有机器学习服务。其中一些正在被集成到核心 Windows 产品和一些 Office 产品中。”
“我们采用了 FastAPI 库来生成一个 REST 服务器，可以通过查询它来获得预测。[用于 Ludwig]”
“Netflix 很高兴地宣布我们的危机管理编排框架 Dispatch 的开源版本！[使用 FastAPI 构建]”
“我对 FastAPI 感到无比兴奋。太有趣了！”
“老实说，你构建的东西看起来非常扎实和精致。在很多方面，它就是我希望 Hug 成为的样子——看到有人能做到这一点真的很鼓舞人心。”
“如果你想学习一个用于构建 REST API 的现代框架，那就看看 FastAPI [...] 它快速、易于使用和学习 [...]”
“我们已经将我们的 API 切换到 FastAPI [...] 我想你会喜欢它的 [...]”
“如果有人想构建一个生产级的 Python API，我强烈推荐 FastAPI。它设计精美、使用简单且高度可扩展，它已成为我们 API 优先开发策略的关键组成部分，并驱动着许多自动化和服务，例如我们的虚拟 TAC 工程师。”
Typer，CLI 世界的 FastAPI¶
如果你正在构建一个在终端中使用的命令行界面应用而不是 Web API，请查看 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 文档将自动更新，包括新的请求体：
- 点击“Try it out”按钮，它允许你填写参数并直接与 API 交互：
- 然后点击“Execute”按钮，用户界面将与你的 API 通信，发送参数，获取结果并显示在屏幕上：
备选 API 文档升级¶
现在，再访问 http://127.0.0.1:8000/redoc。
- 备选文档也将反映新的查询参数和请求体：
总结¶
总而言之，你只需将参数、请求体等的类型一次性声明为函数参数即可。
你使用标准的现代 Python 类型来完成此操作。
你无需学习新的语法、特定库的方法或类等。
只需标准的 Python。
例如，对于一个 int：
item_id: int
或者对于一个更复杂的 Item 模型：
item: Item
...仅凭这一个声明，你就能获得：
- 编辑器支持，包括：
- 代码补全。
- 类型检查。
- 数据校验：
- 当数据无效时，自动生成清晰的错误信息。
- 即使是深度嵌套的 JSON 对象也能进行校验。
- 输入数据的转换：将网络数据转换为 Python 数据和类型。读取自：
- JSON。
- 路径参数。
- 查询参数。
- Cookies。
- 请求头。
- 表单。
- 文件。
- 输出数据的转换：将 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请求中的请求体一样）。
- 由于
- 对于向
/items/{item_id}发送的PUT请求，将请求体读取为 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 ...
...然后看看你的编辑器如何自动补全属性并知道它们的类型：
有关包含更多功能的更完整示例，请参阅教程 - 用户指南。
剧透警告：教程 - 用户指南包括：
- 从其他不同位置声明参数，如：请求头、cookies、表单字段和文件。
- 如何设置验证约束，如
maximum_length或regex。 - 一个非常强大且易于使用的依赖注入系统。
- 安全和身份验证，包括对带 JWT 令牌的 OAuth2 和 HTTP 基本认证的支持。
- 用于声明深度嵌套 JSON 模型的更高级（但同样简单）的技术（得益于 Pydantic）。
- 与 Strawberry 和其他库的 GraphQL 集成。
- 许多额外功能（得益于 Starlette），例如：
- WebSockets
- 基于 HTTPX 和
pytest的极其简单的测试 - CORS
- Cookie 会话
- ...以及更多。
部署你的应用（可选）¶
你可以选择将你的 FastAPI 应用部署到 FastAPI Cloud，如果你还没有加入等候名单，快去加入吧。🚀
如果你已经有一个 FastAPI Cloud 账户（我们从等候名单中邀请了你 😉），你可以用一条命令部署你的应用程序。
部署前，请确保你已登录：
$ fastapi login
You are logged in to FastAPI Cloud 🚀
然后部署你的应用：
$ fastapi deploy
Deploying to FastAPI Cloud...
✅ Deployment successful!
🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev
就是这样！现在你可以在那个 URL 访问你的应用了。✨
关于 FastAPI Cloud¶
FastAPI Cloud 由 FastAPI 背后的同一作者和团队构建。
它以最小的努力简化了 API 的构建、部署和访问过程。
它将使用 FastAPI 构建应用的开发者体验带到了将它们部署到云端的过程中。🎉
FastAPI Cloud 是 FastAPI 及其相关开源项目的主要赞助商和资金提供者。✨
部署到其他云服务提供商¶
FastAPI 是开源的并且基于标准。你可以将 FastAPI 应用部署到你选择的任何云服务提供商。
遵循你的云服务提供商的指南来部署 FastAPI 应用。🤓
性能¶
独立的 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 许可证的条款进行许可。