FastAPI - 在 swagger 中添加路径参数的描述

Question

想象一下有一个这样的应用程序：

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

如何item_id在 swagger 中添加路径参数的描述？

Answer 1

您可以通过使用参数类型对象的实参来添加特定参数的描述：description

item_id: int = Path(..., description="An id representing an item")

代表...默认值，应包含*。

...编辑*：如果包含对象，当前版本的 FastAPI 会引发错误Path，因此如果您使用的是最新（2023）版本，请忽略它。