fastAPI学习笔记

请求方法

标记请求方法类似于加装饰器

常用的有get,post,put,delete 以及 options, head, patch, trace

@app.get('url')
async def read_item():
    return {'xx': 'xxx'}

@app.get()里的参数：

​ 第一个参数是路径地址

​ response_model 指定一个返回的模型，可以是pydantic模型

response_model作用：

• 将输出数据转换成声明的Response模型
• 对数据进行校验
• 生成自动化文档
• 限制输出的数据只能是所声明的Response模型字段

from typing import Union, List, Dict

response_model = Union[a模型, b模型] # 允许模型是这两个其中之一

response_model = List[item] # 列表

response_model = Dict[str, float] # {'foo': 2.3, 'bar': 3.4}

​ response_model_include = {'tax'} # 只返回指定参数

​ response_model_excluce = {'tax'} # 不返回指定参数

​ summary = ‘简要概述’ # doc文档的概述

​ description = """xxxx""" # 接口文档 markdown

​ tags = ['items'] # 在docs中对接口进行归类

请求参数

路径参数： /item/{item_id}/ item_id为路径参数
查询参数： /item/?q=1 q为查询参数
请求体： post等方法中的body 均为请求体
函数参数依次按照如下规则进行识别

• 如果路径中也声明了该函数，它将被作用与路径参数 Path

• 如果是单一类型（如int, float, str, bool等）将被解释为查询参数 Query

• 如果参数的类型被声明为pydantic模型, 它将被解释为请求体 Body

  在模型中可以使用 Field

from enum import Enum
from pydantic import BaseModel
from typing import Optional, List
from fastapi import FastAPI, Query, Path

# 定义pydantic模型
class Item(BaseModel):
    name: str  # 必填
    description: Optional[str] = None  # 可空
    price: float  # 必填
    tax: Optional[float] = None  # 必填
    
# 定义一个枚举类
class ModelItem(str, Enum):
    alexnet = '1'
    resnet = '2'
    lenet = '3'

# 使用Query
Query() 参数描述：
    第一个参数: 默认值
    max_length, min_length,alias:别名,前端传入的参数名,title, description, gt, ge, lt, le, regex, deprecated:bool 表明是否是已弃用的参数
# 使用Path
和query相似，不过适用于路径参数上

# 使用Body
和query类似，适用于请求体

# Cookie
获取cookie

# Header
参数： convert_underscores=True  # 自动转换，下划线转-，另外，http头不区分大小写
如果有重复标头的需求 可以 Optional[List[str]] = Header(None)

def item(q: Optional[str] = Query(None, max_length=50))
如果要声明必填,则可以Query(..., xxxx)
可接收参数列表
def item(q:Optional[List[str]] = Query(None))
    

数据类型

常见数据类型： int， float，str，bool

其他数据类型：UUID, datetime.datetime, datetime.date, datetime.time, datetime.timedelta, frozenset

uuid: str
datetime: 例如：2008-09-15T15:53:00+05:00
date: 2008-09-15
time: 14:23:55.003
timedelta: float 总秒数
frozenset： 请求中等价set，响应