Awesome

<h1 align="center"> FastAPI Responses </h1> <a href="https://github.com/Kludex/fastapi-responses" target="_blank"> <img src="https://img.shields.io/github/last-commit/Kludex/fastapi-responses" alt="Latest Commit"> </a> <img src="https://img.shields.io/github/workflow/status/Kludex/fastapi-responses/Test"> <img src="https://img.shields.io/codecov/c/github/Kludex/fastapi-responses"> <a href="https://pypi.org/project/fastapi-responses" target="_blank"> <img src="https://img.shields.io/pypi/v/fastapi-responses" alt="Package version"> </a> <img src="https://img.shields.io/pypi/pyversions/fastapi-responses"> <img src="https://img.shields.io/github/license/Kludex/fastapi-responses"> Find HTTPExceptions and turn them into documented responses. :tada:

Installation

pip install fastapi-responses

Usage

The simplest use case happens when we have a single exception being raised. We don't want to document the possible response manually, so FastAPI Responses comes in handy.

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!"

Without FastAPI Responses

With FastAPI Responses

Roadmap

Extract HTTPException from stack.
Extract any exception and document based on the exception_handler container.
Accept Python objects on HTTPException instantiation.

License

This project is licensed under the terms of the MIT license.