如何给 fastapi 的 swagger 文档的返回状态码添加多个值？

Z时代
2024-02-21
分类：IT

默认只有 200 和 422

如果我还想一起声明 200、201、401、404、500 等等多个状态码怎么写？

回答：

用@app.get(), @app.post(), 装饰器

from fastapi import FastAPI
from fastapi.responses import JSONResponse
app = FastAPI()
@app.get("/items/", responses={
    200: {
        "description": "Successful Response",
        "content": {
            "application/json": {
                "example": {"item": "Foo"}
            },
        },
    },
    201: {"description": "Created"},
    401: {"description": "Unauthorized"},
    404: {"description": "Not Found"},
    500: {"description": "Internal Server Error"},
})
async def read_items():
    return JSONResponse(content={"item": "Foo"}, status_code=200)