2012-09-02 00:24:33 +04:00
<!DOCTYPE html>
< html lang = "en" > < head > < meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
< title > Django REST framework< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "" >
< meta name = "author" content = "" >
<!-- Le styles -->
2012-09-08 23:24:07 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/prettify.css" rel = "stylesheet" >
2012-09-02 00:37:41 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/bootstrap.css" rel = "stylesheet" >
< link href = "http://tomchristie.github.com/django-rest-framework/css/bootstrap-responsive.css" rel = "stylesheet" >
2012-09-08 11:03:30 +04:00
< link href = "http://tomchristie.github.com/django-rest-framework/css/drf-styles.css" rel = "stylesheet" >
2012-09-02 00:24:33 +04:00
<!-- Le HTML5 shim, for IE6 - 8 support of HTML5 elements -->
<!-- [if lt IE 9]>
< script src = "http://html5shim.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
2012-09-09 19:56:34 +04:00
< body onload = "prettyPrint()" class = "exceptions" >
2012-09-02 00:24:33 +04:00
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
< a class = "btn btn-navbar" data-toggle = "collapse" data-target = ".nav-collapse" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / a >
2012-09-02 00:37:41 +04:00
< a class = "brand" href = "http://tomchristie.github.com/django-rest-framework" > Django REST framework< / a >
2012-09-02 00:24:33 +04:00
< div class = "nav-collapse collapse" >
< ul class = "nav" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework" > Home< / a > < / li >
2012-09-02 00:24:33 +04:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/1-serialization" > 1 - Serialization< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/2-requests-and-responses" > 2 - Requests and responses< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/3-class-based-views" > 3 - Class based views< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/4-authentication-permissions-and-throttling" > 4 - Authentication, permissions and throttling< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/5-relationships-and-hyperlinked-apis" > 5 - Relationships and hyperlinked APIs< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/tutorial/6-resource-orientated-projects" > 6 - Resource orientated projects< / a > < / li >
2012-09-02 00:24:33 +04:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > API Guide < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/requests" > Requests< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/responses" > Responses< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/views" > Views< / a > < / li >
2012-09-12 13:14:01 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/generic-views" > Generic views< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/parsers" > Parsers< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/renderers" > Renderers< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/serializers" > Serializers< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/authentication" > Authentication< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/permissions" > Permissions< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/throttling" > Throttling< / a > < / li >
2012-09-12 13:14:01 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/content-negotiation" > Content negotiation< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/format-suffixes" > Format suffixes< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/reverse" > Returning URLs< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/exceptions" > Exceptions< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/status-codes" > Status codes< / a > < / li >
2012-09-05 16:05:36 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/api-guide/settings" > Settings< / a > < / li >
2012-09-02 00:24:33 +04:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/csrf" > Working with AJAX and CSRF< / a > < / li >
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/formoverloading" > Browser based PUT, PATCH and DELETE< / a > < / li >
2012-09-05 16:05:36 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/contributing" > Contributing to REST framework< / a > < / li >
2012-09-02 00:37:41 +04:00
< li > < a href = "http://tomchristie.github.com/django-rest-framework/topics/credits" > Credits< / a > < / li >
2012-09-02 00:24:33 +04:00
< / ul >
< / li >
< / ul >
< ul class = "nav pull-right" >
2012-09-08 11:03:30 +04:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Version: 2.0.0 < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li > < a href = "#" > Trunk< / a > < / li >
< li > < a href = "#" > 2.0.0< / a > < / li >
< / ul >
< / li >
< / ul >
2012-09-02 00:24:33 +04:00
< / div > <!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "container-fluid" >
< div class = "row-fluid" >
2012-09-08 11:03:30 +04:00
< div class = "span3" >
< div id = "table-of-contents" class = "well affix span3" >
< ul class = "nav nav-list side-nav" >
< li class = "main" > < a href = "#exceptions" > Exceptions< / a > < / li >
2012-09-12 13:14:01 +04:00
< li > < a href = "#exception-handling-in-rest-framework-views" > Exception handling in REST framework views< / a > < / li >
< li > < a href = "#apiexception" > APIException< / a > < / li >
< li > < a href = "#parseerror" > ParseError< / a > < / li >
< li > < a href = "#permissiondenied" > PermissionDenied< / a > < / li >
< li > < a href = "#methodnotallowed" > MethodNotAllowed< / a > < / li >
< li > < a href = "#unsupportedmediatype" > UnsupportedMediaType< / a > < / li >
< li > < a href = "#throttled" > Throttled< / a > < / li >
2012-09-02 00:24:33 +04:00
2012-09-08 11:03:30 +04:00
< / ul >
< / div >
2012-09-02 00:24:33 +04:00
< / div >
2012-09-08 11:03:30 +04:00
< div id = "main-content" class = "span9" >
2012-09-09 01:06:49 +04:00
< p > < a class = "github" href = "https://github.com/tomchristie/django-rest-framework/blob/restframework2/djangorestframework/exceptions.py" > < span class = "label label-info" > exceptions.py< / span > < / a > < / p >
< h1 id = "exceptions" > Exceptions< / h1 >
2012-09-12 13:14:01 +04:00
< blockquote >
< p > Exceptions… allow error handling to be organized cleanly in a central or high-level place within the program structure.< / p >
< p > — Doug Hellmann, < a href = "http://www.doughellmann.com/articles/how-tos/python-exception-handling/index.html" > Python Exception Handling Techniques< / a > < / p >
< / blockquote >
< h2 id = "exception-handling-in-rest-framework-views" > Exception handling in REST framework views< / h2 >
< p > REST framework's views handle various exceptions, and deal with returning appropriate error responses for you.< / p >
< p > The handled exceptions are:< / p >
< ul >
< li > Subclasses of < code > APIException< / code > raised inside REST framework.< / li >
< li > Django's < code > Http404< / code > exception.< / li >
< li > Django's < code > PermissionDenied< / code > exception.< / li >
< / ul >
< p > In each case, REST framework will return a response, rendering it to an appropriate content-type.< / p >
< p > By default all error messages will include a key < code > details< / code > in the body of the response, but other keys may also be included.< / p >
< p > For example, the following request:< / p >
< pre class = "prettyprint lang-py" > < code > DELETE http://api.example.com/foo/bar HTTP/1.1
Accept: application/json
< / code > < / pre >
< p > Might recieve an error response indicating that the < code > DELETE< / code > method is not allowed on that resource:< / p >
< pre class = "prettyprint lang-py" > < code > HTTP/1.1 405 Method Not Allowed
Content-Type: application/json; charset=utf-8
Content-Length: 42
{"detail": "Method 'DELETE' not allowed."}
< / code > < / pre >
< h2 id = "apiexception" > APIException< / h2 >
< p > < strong > Signature:< / strong > < code > APIException(detail=None)< / code > < / p >
< p > The base class for all exceptions raised inside REST framework.< / p >
< p > To provide a custom exception, subclass < code > APIException< / code > and set the < code > .status_code< / code > and < code > .detail< / code > properties on the class.< / p >
< h2 id = "parseerror" > ParseError< / h2 >
< p > < strong > Signature:< / strong > < code > ParseError(detail=None)< / code > < / p >
< p > Raised if the request contains malformed data when accessing < code > request.DATA< / code > or < code > request.FILES< / code > .< / p >
< p > By default this exception results in a response with the HTTP status code "400 Bad Request".< / p >
< h2 id = "permissiondenied" > PermissionDenied< / h2 >
< p > < strong > Signature:< / strong > < code > PermissionDenied(detail=None)< / code > < / p >
< p > Raised when an incoming request fails the permission checks.< / p >
< p > By default this exception results in a response with the HTTP status code "403 Forbidden".< / p >
< h2 id = "methodnotallowed" > MethodNotAllowed< / h2 >
< p > < strong > Signature:< / strong > < code > MethodNotAllowed(method, detail=None)< / code > < / p >
< p > Raised when an incoming request occurs that does not map to a handler method on the view.< / p >
< p > By default this exception results in a response with the HTTP status code "405 Method Not Allowed".< / p >
< h2 id = "unsupportedmediatype" > UnsupportedMediaType< / h2 >
< p > < strong > Signature:< / strong > < code > UnsupportedMediaType(media_type, detail=None)< / code > < / p >
< p > Raised if there are no parsers that can handle the content type of the request data when accessing < code > request.DATA< / code > or < code > request.FILES< / code > .< / p >
< p > By default this exception results in a response with the HTTP status code "415 Unsupported Media Type".< / p >
< h2 id = "throttled" > Throttled< / h2 >
< p > < strong > Signature:< / strong > < code > Throttled(wait=None, detail=None)< / code > < / p >
< p > Raised when an incoming request fails the throttling checks.< / p >
< p > By default this exception results in a response with the HTTP status code "429 Too Many Requests".< / p >
2012-09-02 00:24:33 +04:00
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
2012-09-08 11:03:30 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/jquery-1.8.1-min.js" > < / script >
2012-09-08 23:24:07 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/prettify.js" > < / script >
2012-09-02 00:37:41 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/bootstrap-dropdown.js" > < / script >
< script src = "http://tomchristie.github.com/django-rest-framework/js/bootstrap-scrollspy.js" > < / script >
2012-09-08 11:03:30 +04:00
< script src = "http://tomchristie.github.com/django-rest-framework/js/bootstrap-collapse.js" > < / script >
2012-09-02 00:24:33 +04:00
< script >
2012-09-08 11:03:30 +04:00
//$('.side-nav').scrollspy()
var shiftWindow = function() { scrollBy(0, -50) };
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
2012-09-12 13:14:01 +04:00
$('.dropdown-menu').click(function(event) {
event.stopPropagation();
});
2012-09-02 00:24:33 +04:00
< / script >
< / body > < / html >
