معرفی شرکت ها
drf-standardized-errors-0.9.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Standardize your API error responses.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | drf-standardized-errors-0.9.0 |
| نام | drf-standardized-errors |
| نسخه کتابخانه | 0.9.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Ghazi Abbassi |
| ایمیل نویسنده | - |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/drf-standardized-errors/ |
| مجوز | - |
# 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 a 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
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).
نیازمندی
| مقدار | نام |
|---|---|
| =3. | django |
| =3.1 | djangorestframework |
| - | pre-commit |
| - | sphinx!=5.2.0.post0 |
| - | sphinx-autobuild |
| - | sphinx-rtd-theme>=1.1.0 |
| - | myst-parser |
| - | drf-spectacular |
| - | inflection |
| - | flit |
| - | keyring |
| - | tbump |
| - | tox |
| - | tox-gh-actions |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8 | Python |
نحوه نصب
نصب پکیج whl drf-standardized-errors-0.9.0:
pip install drf-standardized-errors-0.9.0.whl
نصب پکیج tar.gz drf-standardized-errors-0.9.0:
pip install drf-standardized-errors-0.9.0.tar.gz