FastAPI framework, high performance, easy to learn, fast to code, ready for production
FastAPI框架，高性能，易于学习，快速编码，准备投入生产。
文档入口: https://fastapi.tiangolo.com.
框架源码: https://github.com/tiangolo/fastapi.
FastAPI是一个现代的、快速的(高性能的)web框架，用于基于标准Python类型提示用Python 3.6+构建api。
主要特点如下：
快:非常高的性能，与NodeJS和Go(感谢Starlette和Pydantic)。可用的最快的Python框架之一。
快速编码: 提高开发速度约200%到300% 。
减少bug : 减少约40%的人为(开发人员)错误。
直观: 伟大的编辑器的支持，完成无处不在，更少的时间调试。
容易: 设计是为了便于使用和学习。减少阅读文档的时间。
短: 最小化代码重复。每个参数声明的多个特性。更少的错误。
健壮: 获得生产就绪代码。自动交互文档。
基于标准的: 基于(并完全兼容)api的开放标准:OpenAPI(以前称为Swagger)和JSON模式。
Typer, the FastAPI of CLIs
如果您正在构建一个在终端中使用的CLI应用程序，而不是web API，请查看Typer。
开发环境
Python 3.6+版本
-
FastAPI 由以下两大“大牛”支持者:
Starlette 对于web部分.
Pydantic 对于数据部分.
安装
pip install fastapi
您还需要一个ASGI服务器，用于生产，如Uvicorn或Hypercorn。
pip install uvicorn
Demo例子
新建文件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):
return {"item_id": item_id, "q": q}
️如果你的代码使用 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):
return {"item_id": item_id, "q": q}
运行（本地服务器）
uvicorn main:app --reload
命令解析：
-
命令
uvicorn main:app指的是:-
main: 文件main.py(Python“模块”). -
app: 在main.py中使用app = FastAPI()创建的对象。 -
--reload: 在代码更改后重新启动服务器。这样做只是为了开发方便。 - 可以自行输入
uvicorn --help查看命令使用的方法。
-
测试功能
打开浏览器 复制它：http://127.0.0.1:8000/items/5?q=somequery.
您将看到JSON响应如下:
{"item_id": 5, "q": "somequery"}
你已经创建了一个API:
在路径
/和/items/{item_id}中接收HTTP请求。这两条路径都采用
GET操作(也称为HTTP方法)。path:
/items/{item_id}有一个路径参数item_id，它应该是一个整数。path
/items/{item_id}有一个可选的str查询参数q。
交互式API文档
那么，现在改变地址为：[http://127.0.0.1:8000/docs]
(http://127.0.0.1:8000/docs).
你会看到自动化的用于交互的API文档(由Swagger UI提供):
其他的API文档
现在，转到http://127.0.0.1:8000/redoc。
你会看到另一个自动文档(由ReDoc提供):
进阶版-例子（Example）
现在修改文件main.py，以便从PUT请求接收主体。
使用标准Python类型声明主体，这得益于Pydantic。
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str
price: float
is_offer: bool = None
@app.get("/")
def read_root():
return {"Hello": "World"}
@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = 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}
服务器会自动重新加载(因为您添加了--reload到上面的uvicorn命令)。
进阶版-交互式文档
现在，前往http://127.0.0.1:8000/docs
- 交互式API文档将自动更新，包括新的主体:
- 点击“Try it out”按钮，可以填写参数，直接与API交互:
- 然后点击“Execute”按钮，用户界面将与您的API进行通信，发送参数，获取结果并显示在屏幕上:
进阶版-其他可选的API文档
然后现在，转到：http://127.0.0.1:8000/redoc
- 文档还将反映新的查询参数和主体:
知识回顾
总之，只需将参数、主体等类型声明为函数参数，使用标准的现代Python类型就可以做到这一点。
您不必学习新的语法、特定库的方法或类，等等。
只需要标准的Python 3.6+版本。
- 比如，一个
int类型
item_id: int
或者对于更复杂的Item模型:
item: Item
..有了这种声明，你就可以这样:
-
编辑器支持,包括:
智能完成部分代码
类型检查
-
验证数据:
当数据无效时自动清除错误
甚至对深度嵌套的JSON对象进行验证
-
输入数据的转换: 从PC端到Python数据和类型的转换
JSON
Path参数
Query参数
Cookies - 缓存信息
Headers - 请求头
Forms - 表单
Files - 文件
-
输出数据的转换: 从Python数据和类型转换为PC端数据(JSON格式):
转换Python类型(
str、int、float、bool、list等)datetime对象对象
UUID数据库模型
更多
-
自动化交互式API文档，包括2个交互式文档web接口:
Swagger UI
ReDoc
回到前面的代码示例，FastAPI会执行以下操作:
验证GET和PUT请求的路径中是否有
item_id。验证
item_id的类型为int，以用于GET和PUT请求。如果不是，客户端将看到一个有用的、明显的错误。
检查是否有一个名为
q的可选查询参数(如http://127.0.0.1:8000/items/foo?q=somequery)用于获取请求。由于
q参数是用= None声明的，所以它是可选的。如果没有
None，它将是必需的(就像PUT中的主体一样)。对于PUT请求到
/items/{item_id}，将body读取为JSON:检查它是否有一个必需的属性名，该属性名应该是str。
检查它的
required属性price必须是一个浮点数。检查它是否有一个可选属性
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。
- 如何将validation constraints设置为
maximum_length或regex。 - 一个非常强大和容易使用的依赖注入系统。
- 安全性和身份验证，包括使用JWT令牌和HTTP基本验证支持OAuth2。
- 更高级(但同样简单)的技术，用于声明深度嵌套的JSON模型(Pydantic的强力支持)。
- 许多额外的功能(感谢Starlette)作为:
- WebSockets
- GraphQL
- 基于
request和pytest的非常简单的测试 - CORS
- Cookie Sessions - 会话层
- …和更多。
性能 （Performance）
独立的TechEmpower基准测试显示，在Uvicorn下运行的FastAPI应用程序是可用的最快的Python框架之一，仅低于Starlette和Uvicorn本身(由FastAPI内部使用)。(*)
要更多地了解它，请参阅“基准测试”一节。
可选依赖（Optional Dependencies）
使用Pydantic:
ujson- 用于更快的JSON“解析”。email_validator- 用于电子邮件验证。
使用Starlette:
request-- 如果您想要使用TestClient，那么这是必需的。aiofiles—如果您想使用FileResponse或StaticFiles，则必须使用aiofiles。jinja2- 如果你想使用默认的模板配置，jinja2是必须的。python-multipart如果希望支持表单“解析”，那么使用request.form()是必需的。itsdangerous它是危险的——需要SessionMiddleware(会话中间件)支持。pyyaml-需要Starlette的SchemaGenerator支持(您可能不需要FastAPI)。graphere——GraphQLApp支持所需。ujson- 如果您想使用UJSONResponse，则必须使用ujson。
FastAPI / Starlette使用:
uvicorn- 用于加载和服务您的应用程序的服务器。orjson- 如果您想使用ORJSONResponse，则必须使用orjson。
您可以用pip install fastapi[all]安装所有这些东西。