Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghazi-git/drf-standardized-errors
Standardize your DRF API error responses
https://github.com/ghazi-git/drf-standardized-errors
api django django-rest-framework error-formatter error-response exception-handling python standardized-errors
Last synced: 2 months ago
JSON representation
Standardize your DRF API error responses
- Host: GitHub
- URL: https://github.com/ghazi-git/drf-standardized-errors
- Owner: ghazi-git
- License: mit
- Created: 2022-05-07T12:57:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T17:00:21.000Z (9 months ago)
- Last Synced: 2024-04-29T18:07:01.246Z (9 months ago)
- Topics: api, django, django-rest-framework, error-formatter, error-response, exception-handling, python, standardized-errors
- Language: Python
- Homepage: https://drf-standardized-errors.readthedocs.io/en/latest/
- Size: 180 KB
- Stars: 217
- Watchers: 4
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DRF Standardized Errors
Standardize your [DRF](https://www.django-rest-framework.org/) API error responses.
[](https://drf-standardized-errors.readthedocs.io/en/latest/)
[](https://github.com/ghazi-git/drf-standardized-errors/actions/workflows/tests.yml)
[](https://codecov.io/gh/ghazi-git/drf-standardized-errors)
[](https://pypi.org/project/drf-standardized-errors/)
[](https://github.com/ghazi-git/drf-standardized-errors/blob/main/LICENSE)
[](https://github.com/psf/black)
By default, the package will convert all API error responses (4xx and 5xx) to the following standardized format:
```json
{
"type": "validation_error",
"errors": [
{
"code": "required",
"detail": "This field is required.",
"attr": "name"
},
{
"code": "max_length",
"detail": "Ensure this value has at most 100 characters.",
"attr": "title"
}
]
}
```
```json
{
"type": "client_error",
"errors": [
{
"code": "authentication_failed",
"detail": "Incorrect authentication credentials.",
"attr": null
}
]
}
```
```json
{
"type": "server_error",
"errors": [
{
"code": "error",
"detail": "A server error occurred.",
"attr": null
}
]
}
```
## Features
- Highly customizable: gives you flexibility to define your own standardized error responses and override
specific aspects the exception handling process without having to rewrite everything.
- Supports nested serializers and ListSerializer errors
- Plays nicely with error monitoring tools (like Sentry, ...)
## Requirements
- python >= 3.8
- Django >= 3.2
- DRF >= 3.12
## Quickstart
Install with `pip`
```shell
pip install drf-standardized-errors
```
Add drf-standardized-errors to your installed apps
```python
INSTALLED_APPS = [
# other apps
"drf_standardized_errors",
]
```
Register the exception handler
```python
REST_FRAMEWORK = {
# other settings
"EXCEPTION_HANDLER": "drf_standardized_errors.handler.exception_handler"
}
```
### Notes
- This package is a DRF exception handler, so it standardizes errors that reach a DRF API view. That means it cannot
handle errors that happen at the middleware level for example. To handle those as well, you can customize
the necessary [django error views](https://docs.djangoproject.com/en/dev/topics/http/views/#customizing-error-views).
You can find more about that in [this issue](https://github.com/ghazi-git/drf-standardized-errors/issues/44).
- Standardized error responses when `DEBUG=True` for **unhandled exceptions** are disabled by default. That is
to allow you to get more information out of the traceback. You can enable standardized errors instead with:
```python
DRF_STANDARDIZED_ERRORS = {"ENABLE_IN_DEBUG_FOR_UNHANDLED_EXCEPTIONS": True}
```
## Integration with DRF spectacular
If you plan to use [drf-spectacular](https://github.com/tfranzel/drf-spectacular) to generate an OpenAPI 3 schema,
install with `pip install drf-standardized-errors[openapi]`. After that, check the [doc page](https://drf-standardized-errors.readthedocs.io/en/latest/openapi.html)
for configuring the integration.
## Links
- Documentation: https://drf-standardized-errors.readthedocs.io/en/latest/
- Changelog: https://github.com/ghazi-git/drf-standardized-errors/releases
- Code & issues: https://github.com/ghazi-git/drf-standardized-errors
- PyPI: https://pypi.org/project/drf-standardized-errors/
## License
This project is [MIT licensed](LICENSE).