FastAPI

Question

假设有这样一个应用程序：

from fastapi import FastAPI

app = FastAPI()


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

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

Answer 1

像这样

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    """
    item_id: Your item ID description will be here
    """
    return {"item_id": item_id}

招摇文档

Answer 2

您可以为特定的参数添加描述，方法是使用参数类型对象的description参数：

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

...代表默认值，应包括在内。

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

FastAPI - Add description for path parameter in swagger