使用数据类¶
FastAPI 基于Pydantic 构建，我已经向你展示过如何使用 Pydantic 模型声明请求与响应。
但 FastAPI 也支持以相同方式使用dataclasses：
fromdataclassesimportdataclassfromfastapiimportFastAPI@dataclassclassItem:name:strprice:floatdescription:str|None=Nonetax:float|None=Noneapp=FastAPI()@app.post("/items/")asyncdefcreate_item(item:Item):returnitem这仍然得益于Pydantic，因为它对dataclasses 的内置支持。
因此，即便上面的代码没有显式使用 Pydantic，FastAPI 也会使用 Pydantic 将那些标准数据类转换为 Pydantic 风格的 dataclasses。
并且，它仍然支持以下功能：
- 数据验证
- 数据序列化
- 数据文档等
这与使用 Pydantic 模型时的工作方式相同。而且底层实际上也是借助 Pydantic 实现的。
信息
请注意，数据类不能完成 Pydantic 模型能做的所有事情。
因此，你可能仍然需要使用 Pydantic 模型。
但如果你已有一堆数据类，这个技巧可以让它们很好地为使用 FastAPI 的 Web API 所用。🤓
在response_model 中使用数据类¶
你也可以在response_model 参数中使用dataclasses：
fromdataclassesimportdataclass,fieldfromfastapiimportFastAPI@dataclassclassItem:name:strprice:floattags:list[str]=field(default_factory=list)description:str|None=Nonetax:float|None=Noneapp=FastAPI()@app.get("/items/next",response_model=Item)asyncdefread_next_item():return{"name":"Island In The Moon","price":12.99,"description":"A place to be playin' and havin' fun","tags":["breater"],}该数据类会被自动转换为 Pydantic 的数据类。
这样，它的模式会显示在 API 文档界面中：
在嵌套数据结构中使用数据类¶
你也可以把dataclasses 与其它类型注解组合在一起，创建嵌套数据结构。
在某些情况下，你可能仍然需要使用 Pydantic 的dataclasses 版本。例如，如果自动生成的 API 文档出现错误。
在这种情况下，你可以直接把标准的dataclasses 替换为pydantic.dataclasses，它是一个可直接替换的实现：
fromdataclassesimportfield# (1)fromfastapiimportFastAPIfrompydantic.dataclassesimportdataclass# (2)@dataclassclassItem:name:strdescription:str|None=None@dataclassclassAuthor:name:stritems:list[Item]=field(default_factory=list)# (3)app=FastAPI()@app.post("/authors/{author_id}/items/",response_model=Author)# (4)asyncdefcreate_author_items(author_id:str,items:list[Item]):# (5)return{"name":author_id,"items":items}# (6)@app.get("/authors/",response_model=list[Author])# (7)defget_authors():# (8)return[# (9){"name":"Breaters","items":[{"name":"Island In The Moon","description":"A place to be playin' and havin' fun",},{"name":"Holy Buddies"},],},{"name":"System of an Up","items":[{"name":"Salt","description":"The kombucha mushroom people's favorite",},{"name":"Pad Thai"},{"name":"Lonely Night","description":"The mostests lonliest nightiest of allest",},],},]- 我们仍然从标准库的
dataclasses导入field。 pydantic.dataclasses是dataclasses的可直接替换版本。Author数据类包含一个由Item数据类组成的列表。Author数据类被用作response_model参数。- 你可以将其它标准类型注解与数据类一起用作请求体。
在本例中，它是一个Item 数据类列表。6. 这里我们返回一个字典，里面的items 是一个数据类列表。
FastAPI 仍然能够将数据序列化为 JSON。7. 这里的response_model 使用了 “Author 数据类列表” 的类型注解。
同样，你可以将dataclasses 与标准类型注解组合使用。8. 注意，这个路径操作函数 使用的是常规的def 而不是async def。
一如既往，在 FastAPI 中你可以按需组合def 和async def。
如果需要回顾何时用哪一个，请查看关于async 和await{.internal-link target=blank} 的文档中的 _“急不可待？” 一节。9. 这个路径操作函数 返回的不是数据类（当然也可以返回数据类），而是包含内部数据的字典列表。
FastAPI 会使用（包含数据类的）response_model 参数来转换响应。
你可以将dataclasses 与其它类型注解以多种不同方式组合，来构建复杂的数据结构。
更多细节请参考上面代码中的内联注释提示。
深入学习¶
你还可以把dataclasses 与其它 Pydantic 模型组合、从它们继承、把它们包含到你自己的模型中等。
想了解更多，请查看Pydantic 关于 dataclasses 的文档。
版本¶
自 FastAPI 版本0.67.0 起可用。🔖