dict() 函数
函数将对象转化成字典
@validator
@validator('username') def username_alphanumeric(cls, v): assert v.isalnum(), 'must be alphanumeric' return v
路径匹配相关
普通路径参数
@app.get("/users/me") async def read_user_me(): return {"user_id": "the current user"} @app.get("/users/{user_id}") async def read_user(user_id: str): return {"user_id": user_id}
匹配优先级和代码顺序相关,例如users/me在上面的情况就匹配到第一个
限定类型的路径参数
@app.get("/items/{item_id}/article/{num}") async def path_test(item_id: str, num: int): return {"item_id": item_id, "num": num}
如果转换失败就会报错
请求体类型
建议使用pydantic,做了以下事情
- 将请求体识别为 JSON 字符串
- 将字段值转换相应的类型(若有需要)
- 验证数据,如果验证失败,会返回一个清晰的错误,准确指出错误数据的位置和信息
- item 会接收到完整的请求体数据,拥有所有属性及其类型,IDE 也会给予对应的智能提示
- 给 Pydantic 模型自动的生成 JSON Schema,这些 Schema 会成为生成 OpenAPI Schema 的一部分,并显示在接口文档上
from fastapi import FastAPI from typing import Optional from pydantic import BaseModel app = FastAPI() # 自定义一个 Pydantic 模型 class Item(BaseModel): name: str description: Optional[str] = None price: float tax: Optional[float] = None @app.post("/items/") # item 参数的类型指定为 Item 模型 async def create_item(item: Item): return item实际例子-----------
@router.get('/Detail/Get', summary='获取资源关键任务流程详细信息') async def GetresKeyTask(flowId: PyObjectId): feedBackMsg = { "Success": False, "msg": None, "data": None }
当请求体为单一类型的时候:使用body函数
@app.put("/items/{item_id}") async def update_item( item_id: int, item: Item, user: User, importance: int = Body(...) ): results = {"item_id": item_id, "item": item, "user": user, "importance": importance} return results
期待得到的请求体:
{ "item": { "name": "Foo", "description": "The pretender", "price": 42.0, "tax": 3.2 }, "user": { "username": "dave", "full_name": "Dave Grohl" }, "importance": 5 }
注意:
1.如果请求体参数只有一个,def functionA(item:item_model)可以直接传对象格式进来,不需要名字为指定的 "item":{A:1,B:2}的形式
Fields:针对pydantic model内部数据进行校验和添加元数据
Optional:Optional 可选类型,作用几乎和带默认值的参数等价。不同的是使用Optional会告诉你的IDE或者框架:这个参数除了给定的默认值外还可以是None,而且使用有些静态检查工具如mypy时,对 a: int =None这样类似的声明可能会提示报错,但使用a :Optional[int] = None不会。
Field()添加额外的参数: example 参数
例如
description: Optional[str] = Field(None, example="描述")
支持复杂的数据类型:datetime