Custom HTTP Exceptions for FastAPI

Project Description

This library provides a set of custom HTTP exceptions for FastAPI applications, inspired by FastAPI's built-in exceptions. With these custom exceptions, you can simplify error handling by using pre-configured, standard HTTP exception classes tailored to common HTTP status codes.

Installation

To get started, simply install the package via pip:

pip install fastapi-http-exceptions

Usage

Instead of duplicating exception handling code throughout your FastAPI application, you can use the pre-defined exceptions from this library. Raise these exceptions directly without worrying about writing boilerplate code for every status code.

Example 1: Raising Unauthorized Exception

Instead of manually creating HTTP exceptions like this:

from fastapi import HTTPException, status

# Some application logic...
raise HTTPException(
    status_code=status.HTTP_401_UNAUTHORIZED,
    detail="Authentication credentials were not provided"
)

You can import and use a pre-configured exception like this:

from fastapi_http_exceptions import UnauthorizedException

# Some application logic...
raise UnauthorizedException(
  detail="Authentication credentials were not provided",
  headers={}
)

Available Exceptions