FastAPI学习总结
1. 什么是FastAPI?
FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用 Python 3.6+ 并基于标准的 Python 类型提示,
fastapi 是python最快的web框架。
"""
特性:
1.快速,比肩go
2.编码快速,开发快
3.减少人为bug
4.智能,自动补全, 减少调试时间
5.设计易于学习,文档简单
6.简短: 代码量小,bug更少
7.健壮:生产场景,生成交互式文档
8.标准化:基于API的相关的开放标准
"""
2.安装
pip install fastapi # 依赖 pip install uvicorn[standard]
3.最小爱快速示例:
import uvicornfrom typing import Optional, Setfrom fastapi import FastAPI, Path, Queryfrom pydantic import BaseModel
app = FastAPI() # 这里的变量 app 会是 FastAPI 类的一个「实例」,# 这个实例将是创建你所有API 的主要交互对象,每个接口@app.get/put中的app。class Item(BaseModel):
name: str
price: float
is_offer: Optional[bool] = None@app.get("/")def read_root():
return {"Hello": "World"}@app.get("/items/{item_id}")def read_item(item_id: int, q: Optional[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}3.运行
# 3.1 命令运行: uvicorn main:app --reload # 3.2 代码运行: if __name__ == '__main__': uvicorn.run(app=app, host="10.148.228.113", port=65500, workers=1)
4.性能优异
基于 Uvicorn 运行的 FastAPI 程序是 最快的 Python web框架之一,支持异步和并发
5.类型提示:
同样以冒号（:）来声明这个变量。
6.Pydantic 模型¶
Pydantic 是一个用来用来执行数据校验的 Python 库。
7.路径操作装饰器
# 在开发 API 时，你通常使用特定的 HTTP 方法去执行特定的行为 # POST：创建数据。 # GET：读取数据。 # PUT：更新数据。 # DELETE：删除数据。
8.fastapi程序的步骤:
导入 FastAPI。
创建一个 app 实例。
编写一个路径操作装饰器（如 @app.get("/")）。
编写一个路径操作函数（如上面的 def root(): ...）。
运行开发服务器（如 uvicorn main:app --reload）。9.路径参数
路径参数 item_id 的值将作为参数 item_id 传递给你的函数
由于路径操作是按顺序依次运行的，
你需要确保路径 /users/me 声明在路径 /users/{user_id}之前：
否则，/users/{user_id} 的路径还将与 /users/me 相匹配，
"认为"自己正在接收一个值为 "me" 的 user_id 参数。10.查询参数
声明不属于路径参数的其他函数参数时，它们将被自动解释为"查询字符串"参数
查询字符串是键值对的集合，这些键值对位于 URL 的 ？ 之后，并以 & 符号分隔。
fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]@app.get("/items/")async def read_item(skip: int = 0, limit: int = 10):
return fake_items_db[skip : skip + limit]11.请求体参数
请求体是客户端发送给 API 的数据。响应体是 API 发送给客户端的数据。 注意: 要发送数据，你必须使用下列方法之一：POST（较常见）、PUT、DELETE 或 PATCH。
"""
使用 Pydantic 模型来声明请求体
from pydantic import BaseModel
当一个模型属性具有默认值时，它不是必需的
"""
class Item(BaseModel): name: str description: Optional[str] = None price: float tax: Optional[float] = None
12.查询参数和字符串校验
当你在使用 Query 且需要声明一个值是必需的时，可以将 ... 用作第一个参数值：
"""
通用的校验和元数据：
alias
title
description
deprecated
特定于字符串的校验：
min_length
max_length
regex
"""
13.路径参数和数值校验
# 可以使用 Path 为路径参数声明相同类型的校验和元数据。 # 路径参数总是必需的，因为它必须是路径的一部分。 # 所以，你应该在声明时使用 ... 将其标记为必需参数。 # 然而，即使你使用 None 声明路径参数或设置一个其他默认值也不会有任何影响，它依然会是必需参数。# sla_id: str = Path(None, description="SLA的id", example="100191918"))# 数值校验# gt：大于（greater than）# le：小于等于（less than or equal）# item_id: int = Path(..., title="The ID of the item to get", gt=0, le=1000),
14.请求体--多个参数:
async def update_item(item_id: int, item: Item = Body(..., embed=True)):这里的 embed 参数为true时候, 将原本的请求体嵌入到一个键中。{
"item": {
"name": "Foo",
"description": "The pretender",
"price": 42.0,
"tax": 3.2
}}而不是:{
"name": "Foo",
"description": "The pretender",
"price": 42.0,
"tax": 3.2}15.请求体 - 字段(Pydantic 的 Field)
与使用 Query、Path 和 Body 在路径操作函数中声明额外的校验和元数据的方式相同，
你可以使用 Pydantic 的 Field 在 Pydantic 模型内部声明校验和元数据。
Field 的工作方式和 Query、Path 和 Body 相同，包括它们的参数等等也完全相同。
16.请求体--嵌套模型
from pydantic import BaseModel, HttpUrlclass Image(BaseModel): url: HttpUrl name: strclass Item(BaseModel): name: str description: Optional[str] = None price: float tax: Optional[float] = None tags: Set[str] = set() image: Optional[Image] = None
17.模式的额外信息
class Config: schema_extra
声明您的应用可以接收的数据示例。
同样的方法，你可以添加你自己的额外信息，这些信息将被添加到每个模型的JSON模式中，例如定制前端用户界面，等等。
18.cookie参数
Cookie 、Path 、Query是兄弟类，它们都继承自公共的 Param 类
async def read_items(ads_id: Optional[str] = Cookie(None)):
19.Header 参数
token=Header(..., alias="X-Auth-Token", title="X-Auth-Token", description="请求token"),
不用担心变量中的下划线，FastAPI 会负责转换它们。
21.响应模型
在下面的任意的路径操作中使用 response_model 参数来声明用于响应的模型：
@app.get()@app.post()@app.put()@app.delete()
response_model是「装饰器」方法（get，post 等）的一个参数。不像之前的所有参数和请求体，它不属于路径操作函数。
例子:@api.post(
"/restores/{copy_id}/action/download",
status_code=200,
tags=API_TAG,
description="Download API",
summary="download",
response_model=DownloadResponseSchema)22.响应状态码
@app.post("/items/", status_code=201)
会在交互式文档中展示返回在这里定义的状态码
23.表单数据 Form
24.文件上传
from fastapi import FastAPI, File, UploadFile
24.请求表格和文件
async def create_file( file: bytes = File(...), fileb: UploadFile = File(...), token: str = Form(...) ): 当您需要在同一请求中接收数据和文件时File，Form一起使用和。
25.请注意，response_description特指响应，description泛指路径操作。
description可以使用长字符串或者多行文本。用于docs中api接口描述;参数response_description用于响应描述。。
26.tags 参数:
你可以给路径操作(post, put, get, delete)函数添加标记，通过tags参数，参数类型可以是list或者str(一般是一个str):
主要作用就是在docs交互文档中进行 模块之间的分割,mysql模块, filesets 模块
27.总结(summary)和描述(description)
28.Json兼容(将对象转化为json)
from typing import Optionalfrom fastapi.encoders import jsonable_encoderfrom pydantic import BaseModelclass Item(BaseModel):
title: str
timestamp: str
description: Optional[str] = None
item = Item(title='nanfanfa',timestamp="2021.6.21")json_compatible_item_data = jsonable_encoder(item)print(json_compatible_item_data) # {'title': 'nanfanfa', 'timestamp': '2021.6.21', 'description': None}print(json_compatible_item_data) # {'title': 'nanfanfa', 'timestamp': '2021.6.21', 'description': None}if __name__ == '__main__':
uvicorn.run(app=app, host="10.148.228.113", port=65500, workers=1)
作者：程序里的小仙女
链接：https://www.jianshu.com/p/d691faf95d7c