Skip to content

RFC-7807 compliant problem detail error response handler for FastAPI applications

License

Notifications You must be signed in to change notification settings

GeodetischeInfrastructuur/fastapi-rfc7807

 
 

Repository files navigation

fastapi-rfc7807

FastAPI middleware which translates server-side exceptions into RFC-7807 compliant problem detail error responses.

Installation

fastapi_rfc7807 requires Python 3.6+

pip install fastapi_rfc7807

Usage

Below is a simple example which shows the bare minimum needed to configure a FastAPI application with fastapi_rfc7807.

from fastapi import FastAPI 
from fastapi_rfc7807 import middleware

app = FastAPI()
middleware.register(app)


@app.get('/error')
async def error():
    raise ValueError('something went wrong')

The resulting error returned from the server looks like:

$ curl localhost:8000/error
{"exc_type":"ValueError","type":"about:blank","title":"Unexpected Server Error","status":500,"detail":"something went wrong"}

See the examples directory for additional examples.

About

RFC-7807 compliant problem detail error response handler for FastAPI applications

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 95.9%
  • Makefile 2.8%
  • Groovy 1.3%