Skip to main content

FastAPI middleware for RFC-7807 compliant error responses

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_rfc7807-0.2.0.tar.gz (18.7 kB view details)

Uploaded Source

Built Distribution

fastapi_rfc7807-0.2.0-py2.py3-none-any.whl (19.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fastapi_rfc7807-0.2.0.tar.gz.

File metadata

  • Download URL: fastapi_rfc7807-0.2.0.tar.gz
  • Upload date:
  • Size: 18.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.6

File hashes

Hashes for fastapi_rfc7807-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a15dc42ef1d72608813071dd88e0557e802d5c18f22ded45b3231ab8afea3afb
MD5 6a4ab8d5f84b379f377b4d679ad8a54a
BLAKE2b-256 ac76c9775c4869593a054946ecd23191c99992319563faeb2fb87fe197af5ce7

See more details on using hashes here.

Provenance

File details

Details for the file fastapi_rfc7807-0.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: fastapi_rfc7807-0.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.6

File hashes

Hashes for fastapi_rfc7807-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a4c92569cd4f7c936a37f45470dee38cb9021d661ea6ae6748e23dc7dbdd40af
MD5 c10f5f77831d7048b9ea76e5aeb07e64
BLAKE2b-256 476c747a3de8217249f91f169bb440ec518f1a9be0e377a0865b14702ede5806

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page