DRF Standardized Errors

0.15.0 · active · verified Wed Apr 15

drf-standardized-errors is a Python library for Django REST Framework that standardizes API error responses, making them consistent and easier for clients to consume. It is currently at version 0.15.0 and maintains an active release cadence, frequently adding support for new Python, Django, and DRF versions.

Warnings

breaking As of v0.15.0, unhandled exceptions now return a generic error message by default to prevent sensitive data leaks. This changes the previous behavior of exposing the raw exception message.
Fix: To revert to the old behavior or customize the generic message, create a custom exception handler class inheriting from `drf_standardized_errors.handler.DRFStandardizedErrorsExceptionHandler` and override `get_fallback_error_message` or `get_generic_error_response_data`.
breaking If using `drf-spectacular` (versions 0.27.0 or newer), the `SPECTACULAR_SETTINGS["ENUM_NAME_OVERRIDES"]` entries for 'ValidationErrorEnum' and 'ClientErrorEnum' must reference `choices` instead of `values`.
Fix: Update your `SPECTACULAR_SETTINGS` to use `drf_standardized_errors.openapi_serializers.ValidationErrorEnum.choices` and `drf_standardized_errors.openapi_serializers.ClientErrorEnum.choices`.
gotcha Improper configuration of `REST_FRAMEWORK['EXCEPTION_HANDLER']` in `settings.py` will prevent `drf-standardized-errors` from taking effect, resulting in default DRF error responses.
Fix: Ensure the `EXCEPTION_HANDLER` setting precisely matches `"drf_standardized_errors.handler.exception_handler"`.
gotcha Compatibility with `drf-spectacular` for OpenAPI schema generation features is often tied to specific `drf-spectacular` versions. Refer to the release notes for precise version requirements to ensure correct schema generation (e.g., v0.14.0 enforces `drf-spectacular >=0.27`).
Fix: Always check the `drf-standardized-errors` release notes or documentation for required `drf-spectacular` versions and upgrade `drf-spectacular` accordingly if experiencing schema generation issues.

Install

pip install drf-standardized-errors Install stable version

Imports

exception_handler
```
from drf_standardized_errors.handler import exception_handler
```
The exception handler is located in the 'handler' submodule.

DRFStandardizedErrorsExceptionHandler

from drf_standardized_errors.handler import DRFStandardizedErrorsExceptionHandler

Quickstart

To enable standardized error handling, configure `REST_FRAMEWORK['EXCEPTION_HANDLER']` in your Django settings to point to the library's exception handler.

# settings.py
REST_FRAMEWORK = {
    "EXCEPTION_HANDLER": "drf_standardized_errors.handler.exception_handler"
}

view raw JSON →