如何在FastAPI中生成响应描述

问题描述

我想生成所有可用响应的描述（连同代码200示例），如此处所示。

from typing import Any

import uvicorn
from fastapi import FastAPI,HTTPException

router = FastAPI()
from pydantic import BaseModel

class FileItemBase(BaseModel):
    current_project: str = "Test project"

class FileItemInDBBase(FileItemBase):
    id: int
    folder_path: str

    class Config:
        orm_mode = True

class FileResponse(FileItemInDBBase):
    pass

@router.get("/",response_model=FileResponse)
def example_code() -> Any:
    """
    # beautiful description
    to demonstrate functionality
    """
    demo=True
    if demo:
        raise HTTPException(418,"That is a teapot.")
if __name__ =="__main__":
    uvicorn.run(router)

我得到的是这样的描述。

当我尝试此操作时-得到了错误响应（按预期）。

我想要的-是示例响应中包含的错误描述，例如此处。前端开发人员可以查看此描述并以正确的方式处理此类情况，而无需测试API。

我知道如何在OpenAPI specs中实现它。

是否可以使用FastAPI生成此描述？

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）