diff options
| author | Tom Christie | 2013-07-10 14:32:10 +0100 | 
|---|---|---|
| committer | Tom Christie | 2013-07-10 14:32:10 +0100 | 
| commit | 045ad73f69388decff4c26a79ce191bc825672fd (patch) | |
| tree | 40284caecb6cef6f7b0f4ce032ca586a8f24ef81 /docs/api-guide/content-negotiation.md | |
| parent | 77364d2b84aa20030f579076a4b2a92a2c9d5dd4 (diff) | |
| download | django-rest-framework-045ad73f69388decff4c26a79ce191bc825672fd.tar.bz2 | |
Fixing up content negotiation docs
Diffstat (limited to 'docs/api-guide/content-negotiation.md')
| -rw-r--r-- | docs/api-guide/content-negotiation.md | 29 | 
1 files changed, 27 insertions, 2 deletions
| diff --git a/docs/api-guide/content-negotiation.md b/docs/api-guide/content-negotiation.md index 10288c94..2a774278 100644 --- a/docs/api-guide/content-negotiation.md +++ b/docs/api-guide/content-negotiation.md @@ -43,7 +43,11 @@ This is a valid approach as the HTTP spec deliberately underspecifies how a serv  It's unlikely that you'll want to provide a custom content negotiation scheme for REST framework, but you can do so if needed.  To implement a custom content negotiation scheme override `BaseContentNegotiation`. -REST framework's content negotiation classes handle selection of both the appropriate parser for the request, and the appropriate renderer for the response,  so you should implement both the `.select_parser(request, parsers)` and `.select_renderer(request, renderers, format_suffix)` methods. +REST framework's content negotiation classes handle selection of both the appropriate parser for the request, and the appropriate renderer for the response, so you should implement both the `.select_parser(request, parsers)` and `.select_renderer(request, renderers, format_suffix)` methods. + +The `select_parser()` method should return one of the parser instances from the list of available parsers, or `None` if none of the parsers can handle the incoming request. + +The `select_renderer()` method should return a two-tuple of (renderer instance, media type), or raise a `NotAcceptable` exception.  ## Example @@ -61,6 +65,27 @@ request when selecting the appropriate parser or renderer.              """              Select the first renderer in the `.renderer_classes` list.              """ -            return renderers[0] +            return (renderers[0], renderers[0].media_type) + +## Setting the content negotiation + +The default content negotiation class may be set globally, using the `DEFAULT_CONTENT_NEGOTIATION_CLASS` setting.  For example, the following settings would use our example `IgnoreClientContentNegotiation` class. + +    REST_FRAMEWORK = { +        'DEFAULT_CONTENT_NEGOTIATION_CLASS': 'myapp.negotiation.IgnoreClientContentNegotiation', +    } + +You can also set the content negotiation used for an individual view, or viewset, using the `APIView` class based views. + +    class NoNegotiationView(APIView): +        """ +        An example view that does not perform content negotiation. +        """ +        content_negotiation_class = IgnoreClientContentNegotiation + +        def get(self, request, format=None): +            return Response({ +                'accepted media type': request.accepted_renderer.media_type +            })  [accept-header]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html | 
