🔗 API Reference¶

This page lists the main classes, utilities, and helpers you’ll use when working with APIException in your FastAPI project.

Use this as a quick lookup when you want to check arguments, defaults, or core methods.

✅ Available Exports¶

📌 What it is:

A generic, strongly-typed Pydantic model that standardizes all API responses.

from APIException import ResponseModel

message and status are Required fields and the rest is Optional.

📌 What it is:

Your main custom exception class — use this to raise predictable, documented API errors.

from APIException import APIException

✅ Key Args:

• error_code: your BaseExceptionCode enum

• http_status_code: maps to HTTP status

📌 What it is:

Base class for defining your custom business exception codes.

from APIException import BaseExceptionCode

📌 What it is: A helper to document your Swagger/OpenAPI responses easily.

✅ Where to import:
```
from APIException import APIResponse
```
✅ Usage:

• APIResponse.default() → adds standard 400–500 errors.

• APIResponse.custom() → add your own error codes with status.

📌 What it is:

Sets up global handlers to catch APIException and unexpected errors.

✅ Where to import:

from APIException import register_exception_handlers

✅ Key Options:

• use_response_model: bool (default True) | Return responses using ResponseModel.

• use_fallback_middleware: bool (default True) | Catch unhandled exceptions and return a consistent fallback.

Here’s how a typical setup might look:

from APIException import (
    APIException,
    BaseExceptionCode,
    ResponseModel,
    APIResponse,
    register_exception_handlers
)

✔️ Haven’t seen how to integrate yet?
Go to 🚀 Installation

✔️ Want a quick end-to-end setup?
Check out ⚡ Quick Start

✔️ See how to extend this with your own codes:
Read 🗂️ Custom Exception Codes