fastapi/fastapi

FastAPI framework, high performance, easy to learn, fast to code, ready for production

**文档**：[https://fastapi.tiangolo.com](https://fastapi.tiangolo.com) **源代码**：[https://github.com/fastapi/fastapi](https://github.com/fastapi/fastapi) FastAPI 是一个现代、快速（高性能）的 Web 框架，用于基于标准 Python 类型提示使用 Python 构建 API。 主要特性包括： * **快速**：非常高的性能，与 **NodeJS** 和 **Go** 并驾齐驱（得益于 Starlette 和 Pydantic）。[目前可用的最快 Python 框架之一](#performance)。 * **编码快捷**：将功能开发速度提高约 200% 到 300%。 * * **Bug 更少**：减少约 40% 的人为（开发者）诱导错误。 * * **直观**：出色的编辑器支持。补全无处不在。调试时间更少。 * **简单**：设计得易于使用和学习。阅读文档的时间更少。 * **简明**：最小化代码重复。每个参数声明都能实现多种功能。Bug 更少。 * **健壮**：获取可用于生产环境的代码。带有自动交互式文档。 * **基于标准**：基于（并完全兼容）API 的开放标准：[OpenAPI](https://github.com/OAI/OpenAPI-Specification)（以前称为 Swagger）和 [JSON Schema](https://json-schema.org/)。 * 估算基于内部开发团队构建生产应用程序所进行的测试。 ## 评价 ## FastAPI 配置 [**FastAPI Conf '26**](https://fastapiconf.com) 将于 **2026 年 10 月 28 日**在**荷兰阿姆斯特丹**举行。一切关于 FastAPI 的内容，全部来自官方源头。 🎤 ## FastAPI 迷你纪录片 在 2025 年底发布了一部 [FastAPI 迷你纪录片](https://www.youtube.com/watch?v=mpR8ngthqiE)，你可以在线观看： ## **Typer**，CLI 界的 FastAPI 如果你正在构建一个要在终端而不是 Web API 中使用的 CLI 应用，请查看 [**Typer**](https://typer.tiangolo.com/)。 **Typer** 是 FastAPI 的小兄弟。它的目标是成为 **CLI 界的 FastAPI**。 ⌨️ 🚀 ## 依赖要求 FastAPI 站在巨人的肩膀上： * [Starlette](https://www.starlette.dev/) 负责 Web 部分。 * [Pydantic](https://docs.pydantic.dev/) 负责 数据部分。 ## 安装 创建并激活一个 [虚拟环境](https://fastapi.tiangolo.com/virtual-environments/)，然后安装 FastAPI： **注意**：确保你将 `"fastapi[standard]"` 放在引号中，以确保它在所有终端中都能正常工作。 ## 示例 ### 创建它 创建一个文件 `main.py`，内容如下： ``` 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} ```

或者使用 async def...

如果你的代码使用 `async` / `await`，请使用 `async def`： ``` 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} ``` **注意**： 如果你不了解，请查看文档中的 _“赶时间？”_ 部分，了解 [`async` 和 `await`](https://fastapi.tiangolo.com/async/#in-a-hurry)。

### 运行它 使用以下命令运行服务器：

关于 fastapi dev 命令...

`fastapi dev` 命令会自动读取你的 `main.py` 文件，检测其中的 **FastAPI** 应用，并使用 [Uvicorn](https://www.uvicorn.dev) 启动服务器。 默认情况下，`fastapi dev` 将启用自动重载以进行本地开发。 你可以在 [FastAPI CLI 文档](https://fastapi.tiangolo.com/fastapi-cli/)中阅读更多相关信息。

### 检查它 在浏览器中打开 [http://127.0.0.1:8000/items/5?q=somequery](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](http://127.0.0.1:8000/docs)。 你将看到自动生成的交互式 API 文档（由 [Swagger UI](https://github.com/swagger-api/swagger-ui) 提供）：  ### 备选 API 文档 现在，转到 [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc)。 你将看到备选的自动文档（由 [ReDoc](https://github.com/Rebilly/ReDoc) 提供）：  ## 升级示例 现在修改文件 `main.py` 以接收来自 `PUT` 请求的 body。 借助 Pydantic，使用标准 Python 类型声明 body。 ``` 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 文档升级 现在转到 [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)。 * 交互式 API 文档将自动更新，包括新的 body：  * 点击“Try it out”按钮，它允许你填写参数并直接与 API 交互：  * 然后点击“Execute”按钮，用户界面将与你的 API 通信，发送参数，获取结果并显示在屏幕上：  ### 备选 API 文档升级 现在，转到 [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc)。 * 备选文档也将反映新的查询参数和 body：  ### 回顾 总之，你只需将参数、body 等的类型作为函数参数声明**一次**即可。 你使用标准的现代 Python 类型来完成此操作。 你不需要学习新语法、特定库的方法或类等。 只需使用标准的 **Python**。 例如，对于一个 `int`： ``` item_id: int ``` 或者对于一个更复杂的 `Item` 模型： ``` item: Item ``` ...有了这个单一的声明，你将获得： * 编辑器支持，包括： * 补全。 * 类型检查。 * 数据验证： * 当数据无效时提供自动且清晰的错误。 * 甚至对深度嵌套的 JSON 对象也能进行验证。 * 输入数据的转换：将来自网络的数据转换为 Python 数据和类型。读取自： * JSON。 * 路径参数。 * 查询参数。 * Cookies。 * Headers。 * Forms。 * Files。 * 输出数据的转换：从 Python 数据和类型转换为网络数据（如 JSON）： * 转换 Python 类型（`str`, `int`, `float`, `bool`, `list` 等）。 * `datetime` 对象。 * `UUID` 对象。 * 数据库模型。 * ...以及更多。 * 自动交互式 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` 请求中的 body 一样）。 * 对于 `/items/{item_id}` 的 `PUT` 请求，读取 JSON 格式的 body： * 检查它是否具有必需的属性 `name`，该属性应为 `str`。 * 检查它是否具有必需的属性 `price`，该属性必须为 `float`。 * 检查它是否具有可选的属性 `is_offer`，如果存在，则应为 `bool`。 * 所有这些也将适用于深度嵌套的 JSON 对象。 * 自动从 JSON 转换和转换为 JSON。 * 使用 OpenAPI 记录所有内容，可供以下方面使用： * 交互式文档系统。 * 多种语言的自动客户端代码生成系统。 * 直接提供 2 个交互式文档 Web 界面。 我们只触及了皮毛，但你已经了解了它是如何运作的。 尝试更改这一行： ``` return {"item_name": item.name, "item_id": item_id} ``` ...从： ``` ... "item_name": item.name ... ``` ...更改为： ``` ... "item_price": item.price ... ``` ...并查看你的编辑器将如何自动补全属性并知道它们的类型：  有关包含更多功能的更完整示例，请参阅 教程 - 用户指南。 **剧透警告**：教程 - 用户指南包括： * 从其他不同位置声明 **参数**，例如：**headers**、**cookies**、**表单字段**和**文件**。 * 如何设置**验证约束**，例如 `maximum_length` 或 `regex`。 * 一个非常强大且易于使用的依赖注入** 系统。 * 安全性和身份验证，包括支持带有 **JWT tokens** 的 **OAuth2** 和 **HTTP Basic** 身份验证。 * 声明**深度嵌套 JSON 模型**的更高级（但同样简单）的技术（得益于 Pydantic）。 * 使用 [Strawberry](https://strawberry.rocks) 和其他库进行 **GraphQL** 集成。 * 许多额外功能（得益于 Starlette），例如： * **WebSockets** * 基于 HTTPX 和 `pytest` 的极其简单的测试 * **CORS** * **Cookie Sessions** * ...以及更多。 ### 部署你的应用（可选） 你可以选择使用单个命令将你的 FastAPI 应用部署到 [FastAPI Cloud](https://fastapicloud.com)。 🚀 CLI 将自动检测你的 FastAPI 应用并将其部署到云端。如果你未登录，你的浏览器将打开以完成身份验证过程。 就是这样！现在你可以通过该 URL 访问你的应用。 ✨ #### 关于 FastAPI Cloud **[FastAPI Cloud](https://fastapicloud.com)** 由 **FastAPI** 背后的同一作者和团队构建。 它简化了以最少精力**构建**、**部署**和**访问** API 的过程。 它将使用 FastAPI 构建应用的相同**开发者体验**带到了将它们**部署**到云端的过程中。 🎉 FastAPI Cloud 是 *FastAPI 和朋友们* 开源项目的主要赞助商和资金提供者。 ✨ #### 部署到其他云服务提供商 FastAPI 是开源的且基于标准。你可以将 FastAPI 应用部署到你选择的任何云服务提供商。 遵循你的云服务提供商的指南，与他们一起部署 FastAPI 应用。 🤓 ## 性能 独立的 TechEmpower 基准测试表明，在 Uvicorn 下运行的 **FastAPI** 应用程序是[目前可用的最快 Python 框架之一](https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7)，仅排在 Starlette 和 Uvicorn（由 FastAPI 内部使用）之后。(*) 要了解更多相关信息，请参阅 [基准测试](https://fastapi.tiangolo.com/benchmarks/)部分。 ## 依赖项 FastAPI 依赖于 Pydantic 和 Starlette。 ### `standard` 依赖项 当你使用 `pip install "fastapi[standard]"` 安装 FastAPI 时，它会包含 `standard` 可选依赖组： 被 Pydantic 使用： * [`email-validator`](https://github.com/JoshData/python-email-validator) - 用于电子邮件验证。 被 Starlette 使用： * [`httpx`](https://www.python-httpx.org) - 如果你想使用 `TestClient` 则是必需的。 * [`jinja2`](https://jinja.palletsprojects.com) - 如果你想使用默认模板配置则是必需的。 * [`python-multipart`](https://github.com/Kludex/python-multipart) - 如果你想使用 `request.form()` 支持表单“解析”则是必需的。 被 FastAPI 使用： * [`uvicorn`](https://www.uvicorn.dev) - 用于加载和提供你的应用的服务器。这包括 `uvicorn[standard]`，后者包含高性能服务所需的一些依赖项（例如 `uvloop`）。 * `fastapi-cli[standard]` - 用于提供 `fastapi` 命令。 * 这包括 `fastapi-cloud-cli`，它允许你将 FastAPI 应用部署到 [FastAPI Cloud](https://fastapicloud.com)。 ### 不带 `standard` 依赖项 如果你不想包含 `standard` 可选依赖项，你可以使用 `pip install fastapi` 而不是 `pip install "fastapi[standard]"` 来安装。 ### 不带 `fastapi-cloud-cli` 如果你想安装带有 standard 依赖项但没有 `fastapi-cloud-cli` 的 FastAPI，你可以使用 `pip install "fastapi[standard-no-fastapi-cloud-cli]"` 来安装。 ### 额外可选依赖项 你可能需要安装一些额外的依赖项。 额外的可选 Pydantic 依赖项： * [`pydantic-settings`](https://docs.pydantic.dev/latest/usage/pydantic_settings/) - 用于设置管理。 * [`pydantic-extra-types`](https://docs.pydantic.dev/latest/usage/types/extra_types/extra_types/) - 用于与 Pydantic 一起使用的额外类型。 额外的可选 FastAPI 依赖项： * [`orjson`](https://github.com/ijl/orjson) - 如果你想使用 `ORJSONResponse` 则是必需的。 * [`ujson`](https://github.com/esnme/ultrajson) - 如果你想使用 `UJSONResponse` 则是必需的。 ## 许可证 该项目在 MIT 许可证条款下授权。

标签：API, AV绕过, FastAPI, Python, Web框架, 后端开发, 无后门, 逆向工具