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
Release history Release notifications | RSS feed
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 hashes)
Built Distribution
Close
Hashes for fastapi_rfc7807-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4c92569cd4f7c936a37f45470dee38cb9021d661ea6ae6748e23dc7dbdd40af |
|
MD5 | c10f5f77831d7048b9ea76e5aeb07e64 |
|
BLAKE2b-256 | 476c747a3de8217249f91f169bb440ec518f1a9be0e377a0865b14702ede5806 |