标签：26 description tags FastAPI app item items Path users

再次声明下，什么是路径操作

• @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 文档

 

标签：26,description,tags,FastAPI,app,item,items,Path,users
来源： https://www.cnblogs.com/poloyy/p/15321515.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。