DRF Standardized Errors

Standardize your DRF API error responses.

Table of Contents

• Quickstart
  • Important Notes
  • Integration with DRF spectacular
• Settings
• Error Response Format
  • Error Types
    • Validation Errors
    • Client Errors
    • Server Errors
  • Multiple Errors Support
  • Nested Serializers Support
  • List Serializers Support
• Customization
  • Exception handling flow
  • Sample customizations
    • Handle a non-DRF exception
    • Change the format of the error response
• Gotchas
  • Writing tests
    • TL;DR
    • The long version
• Integration wth drf-spectacular
  • Configuration
  • Notes
  • Tips and Tricks
    • Hide error responses that show in every operation
      • Hide parse error responses
    • Already using a custom AutoSchema class
    • Custom status code
    • Custom error format
    • Customize error codes on an operation basis
      • extend_validation_errors()
• Sample API Description
  • Overview
  • Authentication
  • Errors
    • 401 Unauthorized
    • 405 Method Not Allowed
    • 406 Not Acceptable
    • 415 Unsupported Media Type
    • 500 Internal Server Error
• Development
  • Contributing
  • Run tests locally
  • Documentation
• Release
  • Automated Release
  • Manual Release Steps
• Changelog
  • [UNRELEASED]
    • Added
  • [0.14.1] - 2024-08-10
    • Added
    • Fixed
  • [0.14.0] - 2024-06-19
    • Added
    • Fixed
  • [0.13.0] - 2024-02-28
    • Changed
    • Added
    • Fixed
  • [0.12.6] - 2023-10-25
    • Added
    • Fixed
  • [0.12.5] - 2023-01-14
    • Added
    • Fixed
  • [0.12.4] - 2022-12-11
    • Fixed
  • [0.12.3] - 2022-11-13
    • Added
  • [0.12.2] - 2022-09-25
    • Added
  • [0.12.1] - 2022-09-03
    • Fixed
  • [0.12.0] - 2022-08-27
    • Added
  • [0.11.0] - 2022-06-24
    • Changed (Backward-incompatible)
  • [0.10.2] - 2022-05-08
    • Fixed
  • [0.10.1] - 2022-05-08
    • Fixed
  • [0.10.0] - 2022-05-08
    • Added
  • [0.9.0] - 2022-05-07
    • Added

Credits

This package was inspired by DRF Exceptions Hog but, with an emphasis on the ability to customize the error response format to your liking while keeping the implementation of the exception handler as close as possible to the original DRF implementation.