FastAPI响应

查找HTTPException并将它们转换为文档化的响应。 :tada

安装

pip install fastapi-responses

使用方法

最简单的用例发生在我们有一个异常被抛出的情况下。我们不希望手动记录可能的响应，因此FastAPI Responses非常有用。

from fastapi import FastAPI, HTTPException
from fastapi_responses import custom_openapi

app = FastAPI()

app.openapi = custom_openapi(app)

@app.get("/{item_id}")
def get_item(item_id: int):
    if item_id == 0:
        raise HTTPException(status_code=404, detail="Item not found.")
    return "Item exists!"

没有FastAPI Responses

带有FastAPI Responses

路线图

• 从堆中提取HTTPException。
• 根据exception_handler容器提取任何异常并进行文档记录。
• 在HTTPException实例化时接受Python对象。

许可

本项目采用MIT许可条款。