FastApi

介绍

• 快速：可与 NodeJS 和 Go 比肩的极高性能（归功于 Starlette 和 Pydantic）。最快的 Python web 框架之一。

• 高效编码：提高功能开发速度约 200％ 至 300％。*

• 更少 bug：减少约 40％ 的人为（开发者）导致错误。*

• 智能：极佳的编辑器支持。处处皆可，减少调试时间。
自动补全

• 简单：设计的易于使用和学习，阅读文档的时间更短。

• 简短：使代码重复最小化。通过不同的参数声明实现丰富功能。bug 更少。

• 健壮：生产可用级别的代码。还有自动生成的交互式文档。

• 标准化：基于（并完全兼容）API 的相关开放标准：OpenAPI (以前被称为 Swagger) 和 JSON Schema。

依赖

安装

既然是学习 fastapi 框架，就需要安装 fastapi 包
pip install fastapi

另外还需要安装 ASGI 服务器
pip install uvicorn[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}

运行

• 通过 路径 / 和 /items/{item_id} 接受 HTTP 请求。

• 以上 路径 都接受 GET 操作（也被称为 HTTP 方法）。

• /items/{item_id} 路径 有一个 路径参数 item_id 并且应该为 int 类型。

• /items/{item_id} 路径 有一个可选的 str 类型的 查询参数 q。

交互式 API 文档

可选的 API 文档

示例升级

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}

可选文档升级

• 可选文档同样会体现新加入的请求参数和请求体：

总结

item_id: int

item: Item

• 编辑器支持，包括：
• 自动补全
• 类型检查

• 数据校验：
• 在校验失败时自动生成清晰的错误信息
• 对多层嵌套的 JSON 对象依然执行校验

• 转换 来自网络请求的输入数据为 Python 数据类型。包括以下数据：
• JSON
• 路径参数
• 查询参数
• Cookies
• 请求头
• 表单
• 文件

• 转换 输出的数据：转换 Python 数据类型为供网络传输的 JSON 数据：
• 转换 Python 基础类型 （str、 int、 float、 bool、 list 等）
• datetime 对象
• UUID 对象
• 数据库模型
• ......以及更多其他类型

• 自动生成的交互式 API 文档，包括两种可选的用户界面：
• Swagger UI
• ReDoc

• 校验 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 进行转换或转换成 JSON。

• 通过 OpenAPI 文档来记录所有内容，可被用于：
• 交互式文档系统
• 许多编程语言的客户端代码自动生成系统

• 直接提供 2 种交互式文档 web 界面。

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

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

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

• 对来自不同地方的参数进行声明，如：请求头、cookies、form 表单以及上传的文件。

• 如何设置校验约束如 maximum_length 或者 regex。

• 一个强大并易于使用的 依赖注入 系统。

• 安全性和身份验证，包括通过 JWT 令牌和 HTTP 基本身份认证来支持 OAuth2。

• 更进阶（但同样简单）的技巧来声明 多层嵌套 JSON 模型 （借助 Pydantic）。

• 许多额外功能（归功于 Starlette）比如：
• WebSockets
• GraphQL
• 基于 requests 和 pytest 的极其简单的测试
• CORS
• Cookie Sessions
• ......以及更多

性能

可选依赖

• ujson - 更快的 JSON 。「解析」

• email_validator - 用于 email 校验。

• requests - 使用 TestClient 时安装。

• jinja2 - 使用默认模板配置时安装。

• python-multipart - 需要通过 request.form() 对表单进行时安装。「解析」

• itsdangerous - 需要 SessionMiddleware 支持时安装。

• pyyaml - 使用 Starlette 提供的 SchemaGenerator 时安装（有 FastAPI 你可能并不需要它）。

• graphene - 需要 GraphQLApp 支持时安装。

• ujson - 使用 UJSONResponse 时安装。

• uvicorn - 用于加载和运行你的应用程序的服务器。

• orjson - 使用 ORJSONResponse 时安装。