Skip to content

Commit 611b26d

Browse files
committed
Update README
1 parent 4f841c4 commit 611b26d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,13 @@ A library for [Django Rest Framework](https://www.django-rest-framework.org/) re
1111

1212
This library was built with [RFC7807](https://tools.ietf.org/html/rfc7807) guidelines in mind, but with a small twist: it defines a "problem detail" as a list, but it still serves as a way to include errors in a predictable and easy-to-parse format for any API consumer. Error messages are formatted using RFC7807 keywords and DRF exception data.
1313

14-
Compared to other similar and popular libraries, this library is based on RFC7807 guidelines and aims to provide not only a standardized format for error details, but also human readability.
14+
## What's different?
15+
16+
Compared to other similar and popular libraries, this library:
17+
18+
- Is based on RFC7807 guidelines
19+
- Aims to provide not only a standardized format for error details, but also human-readable error messages (perfect for both internal and public APIs)
20+
- Transforms both `django.core.exceptions.ValidationError` and `rest_framework.errors.ValidationError` to API errors, so you don't have to handle error raised by services/domain logic, `clean()`, or other functions/methods
1521

1622
## Table of Contents
1723

0 commit comments

Comments
 (0)