如何在FastAPI文档中移除默认显示的200响应？

要让接口文档只显示201状态码、移除默认的200响应，你需要做两个关键调整：

• 在add_api_route中明确指定接口的默认状态码为201 Created，覆盖FastAPI默认的200配置
• 确保responses字典中只保留你需要的201响应配置，不要添加多余的200条目

修改后的完整代码 #

import uvicorn
from fastapi import FastAPI, APIRouter
from pydantic import BaseModel
from starlette import status

app = FastAPI()

def test():
    print("creating the resource")
    return {"detail": "Hello world"}  # 返回符合MessageResponse结构的数据

router = APIRouter()

class MessageResponse(BaseModel):
    detail: str

router.add_api_route(
    path="/test",
    endpoint=test,
    methods=["POST"],
    status_code=status.HTTP_201_CREATED,  # 指定默认状态码为201
    responses={
        status.HTTP_201_CREATED: {"model": MessageResponse}
    }
)

app.include_router(router)

def main():
    uvicorn.run("run:app", host="0.0.0.0", reload=True, port=8001)

if __name__ == "__main__":
    main()

关键说明 #

• FastAPI默认会为所有接口添加200成功响应的文档配置，除非你通过status_code参数指定其他默认成功状态码
• 接口返回值要和MessageResponse的结构匹配，这样文档里的响应示例才会正确显示
• 你之前尝试添加response_model=None和200空配置的做法，反而会让文档保留200响应条目，因此需要移除这些多余配置

内容的提问来源于stack exchange，提问作者Amin Ba