FastAPI(26)- Path Operation Configuration 路径操作的配置
再次声明下,什么是路径操作
- @app.get()
- @app.post()
- @app.put()
- @app.delete()
- ...
这些就是路径操作
那路径操作的配置,其实就是函数参数
为什么要讲配置
可以在 Swagger API 文档中显示这些参数,友好的显示相关信息
来看看有什么配置
response_model 相关的前面已经讲过了:https://www.cnblogs.com/poloyy/p/15317585.html
status_code 也是:https://www.cnblogs.com/poloyy/p/15318139.html
这一篇会讲的配置项
- tags
- summary
- description
- deprecated
- name
实际栗子
class Item(BaseModel): name: str description: Optional[str] = None price: float tax: Optional[float] = None tags: Set[str] = [] @app.post("/items/", response_model=Item, tags=["items"], deprecated=True, ) async def create_item(item: Item): return item @app.get("/items/", tags=["items"], status_code=status.HTTP_201_CREATED, summary="Create an item =======", description="路径操作描述", response_description="响应描述" ) async def read_items(): return [{"name": "Foo", "price": 42}]
查看 Swagger API 文档
description 的第二种传参方式
这种方式可以在字符串内写 MarkDown 哦,FastAPI 可以识别到它
@app.get("/users/", tags=["users"]) async def read_users(): """ Create an Users with all the information: tags is users """ return [{"username": "johndoe"}]
查看 Swagger API 文档
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· AI与.NET技术实操系列:基于图像分类模型对图像进行分类
· go语言实现终端里的倒计时
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 分享一个免费、快速、无限量使用的满血 DeepSeek R1 模型,支持深度思考和联网搜索!
· 基于 Docker 搭建 FRP 内网穿透开源项目(很简单哒)
· 25岁的心里话
· ollama系列01:轻松3步本地部署deepseek,普通电脑可用
· 按钮权限的设计及实现
2020-09-25 Cypress系列(53)- as() 命令详解