mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-02-09 08:00:52 +03:00
Update exception docs. Closes #2378.
This commit is contained in:
parent
d3b2302588
commit
271b638df1
|
@ -18,7 +18,7 @@ The handled exceptions are:
|
||||||
|
|
||||||
In each case, REST framework will return a response with an appropriate status code and content-type. The body of the response will include any additional details regarding the nature of the error.
|
In each case, REST framework will return a response with an appropriate status code and content-type. The body of the response will include any additional details regarding the nature of the error.
|
||||||
|
|
||||||
By default all error responses will include a key `detail` in the body of the response, but other keys may also be included.
|
Most error responses will include a key `detail` in the body of the response.
|
||||||
|
|
||||||
For example, the following request:
|
For example, the following request:
|
||||||
|
|
||||||
|
@ -33,6 +33,16 @@ Might receive an error response indicating that the `DELETE` method is not allow
|
||||||
|
|
||||||
{"detail": "Method 'DELETE' not allowed."}
|
{"detail": "Method 'DELETE' not allowed."}
|
||||||
|
|
||||||
|
Validation errors are handled slightly differently, and will include the field names as the keys in the response. If the validation error was not specific to a particular field then it will use the "non_field_errors" key, or whatever string value has been set for the `NON_FIELD_ERRORS_KEY` setting.
|
||||||
|
|
||||||
|
Any example validation error might look like this:
|
||||||
|
|
||||||
|
HTTP/1.1 400 Bad Request
|
||||||
|
Content-Type: application/json
|
||||||
|
Content-Length: 94
|
||||||
|
|
||||||
|
{"amount": ["A valid integer is required."], "description": ["This field may not be blank."]}
|
||||||
|
|
||||||
## Custom exception handling
|
## Custom exception handling
|
||||||
|
|
||||||
You can implement custom exception handling by creating a handler function that converts exceptions raised in your API views into response objects. This allows you to control the style of error responses used by your API.
|
You can implement custom exception handling by creating a handler function that converts exceptions raised in your API views into response objects. This allows you to control the style of error responses used by your API.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user