diff options
| author | Tom Christie | 2014-12-03 23:24:06 +0000 | 
|---|---|---|
| committer | Tom Christie | 2014-12-03 23:24:06 +0000 | 
| commit | 3d6620c72a9cbaedecc37cc76e591a79409de305 (patch) | |
| tree | ee3b2a12ee552daac3a49862ae2fc6e934975b34 /docs/api-guide | |
| parent | cd4d8660211e7af3b06986b68a9281be0b8ffacf (diff) | |
| parent | 731c8421afe3093a78cdabb9c3cc28fa52cd1c8e (diff) | |
| download | django-rest-framework-3d6620c72a9cbaedecc37cc76e591a79409de305.tar.bz2 | |
Merge
Diffstat (limited to 'docs/api-guide')
| -rw-r--r-- | docs/api-guide/parsers.md | 22 | ||||
| -rw-r--r-- | docs/api-guide/renderers.md | 42 | ||||
| -rw-r--r-- | docs/api-guide/settings.md | 4 | ||||
| -rw-r--r-- | docs/api-guide/testing.md | 4 | 
4 files changed, 16 insertions, 56 deletions
| diff --git a/docs/api-guide/parsers.md b/docs/api-guide/parsers.md index 32819146..9323d382 100644 --- a/docs/api-guide/parsers.md +++ b/docs/api-guide/parsers.md @@ -26,26 +26,26 @@ As an example, if you are sending `json` encoded data using jQuery with the [.aj  ## Setting the parsers -The default set of parsers may be set globally, using the `DEFAULT_PARSER_CLASSES` setting.  For example, the following settings would allow requests with `YAML` content. +The default set of parsers may be set globally, using the `DEFAULT_PARSER_CLASSES` setting.  For example, the following settings would allow requests with `JSON` content.      REST_FRAMEWORK = {          'DEFAULT_PARSER_CLASSES': ( -            'rest_framework.parsers.YAMLParser', +            'rest_framework.parsers.JSONParser',          )      }  You can also set the parsers used for an individual view, or viewset,  using the `APIView` class based views. -	from rest_framework.parsers import YAMLParser +	from rest_framework.parsers import JSONParser  	from rest_framework.response import Response      from rest_framework.views import APIView      class ExampleView(APIView):          """ -        A view that can accept POST requests with YAML content. +        A view that can accept POST requests with JSON content.          """ -        parser_classes = (YAMLParser,) +        parser_classes = (JSONParser,)          def post(self, request, format=None):              return Response({'received data': request.data}) @@ -53,10 +53,10 @@ using the `APIView` class based views.  Or, if you're using the `@api_view` decorator with function based views.      @api_view(['POST']) -    @parser_classes((YAMLParser,)) +    @parser_classes((JSONParser,))      def example_view(request, format=None):          """ -        A view that can accept POST requests with YAML content. +        A view that can accept POST requests with JSON content.          """          return Response({'received data': request.data}) @@ -70,14 +70,6 @@ Parses `JSON` request content.  **.media_type**: `application/json` -## YAMLParser - -Parses `YAML` request content. - -Requires the `pyyaml` package to be installed. - -**.media_type**: `application/yaml` -  ## FormParser  Parses HTML form content.  `request.data` will be populated with a `QueryDict` of data. diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md index 1490eef6..69460dbc 100644 --- a/docs/api-guide/renderers.md +++ b/docs/api-guide/renderers.md @@ -18,11 +18,11 @@ For more information see the documentation on [content negotiation][conneg].  ## Setting the renderers -The default set of renderers may be set globally, using the `DEFAULT_RENDERER_CLASSES` setting.  For example, the following settings would use `YAML` as the main media type and also include the self describing API. +The default set of renderers may be set globally, using the `DEFAULT_RENDERER_CLASSES` setting.  For example, the following settings would use `JSON` as the main media type and also include the self describing API.      REST_FRAMEWORK = {          'DEFAULT_RENDERER_CLASSES': ( -            'rest_framework.renderers.YAMLRenderer', +            'rest_framework.renderers.JSONRenderer',              'rest_framework.renderers.BrowsableAPIRenderer',          )      } @@ -31,15 +31,15 @@ You can also set the renderers used for an individual view, or viewset,  using the `APIView` class based views.      from django.contrib.auth.models import User -    from rest_framework.renderers import JSONRenderer, YAMLRenderer +    from rest_framework.renderers import JSONRenderer      from rest_framework.response import Response      from rest_framework.views import APIView      class UserCountView(APIView):          """ -        A view that returns the count of active users, in JSON or YAML. +        A view that returns the count of active users in JSON.          """ -        renderer_classes = (JSONRenderer, YAMLRenderer) +        renderer_classes = (JSONRenderer, )          def get(self, request, format=None):              user_count = User.objects.filter(active=True).count() @@ -93,38 +93,6 @@ The default JSON encoding style can be altered using the `UNICODE_JSON` and `COM  **.charset**: `None` -## YAMLRenderer - -Renders the request data into `YAML`. - -Requires the `pyyaml` package to be installed. - -Note that non-ascii characters will be rendered using `\uXXXX` character escape.  For example: - -    unicode black star: "\u2605" - -**.media_type**: `application/yaml` - -**.format**: `'.yaml'` - -**.charset**: `utf-8` - -## UnicodeYAMLRenderer - -Renders the request data into `YAML`. - -Requires the `pyyaml` package to be installed. - -Note that non-ascii characters will not be character escaped.  For example: - -    unicode black star: ★ - -**.media_type**: `application/yaml` - -**.format**: `'.yaml'` - -**.charset**: `utf-8` -  ## TemplateHTMLRenderer  Renders data to HTML, using Django's standard template rendering. diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 9005511b..623d89fb 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -12,10 +12,10 @@ For example your project's `settings.py` file might include something like this:      REST_FRAMEWORK = {          'DEFAULT_RENDERER_CLASSES': ( -            'rest_framework.renderers.YAMLRenderer', +            'rest_framework.renderers.JSONRenderer',          ),          'DEFAULT_PARSER_CLASSES': ( -            'rest_framework.parsers.YAMLParser', +            'rest_framework.parsers.JSONParser',          )      } diff --git a/docs/api-guide/testing.md b/docs/api-guide/testing.md index d059fdab..cd8c7820 100644 --- a/docs/api-guide/testing.md +++ b/docs/api-guide/testing.md @@ -255,14 +255,14 @@ The default format used to make test requests may be set using the `TEST_REQUEST  If you need to test requests using something other than multipart or json requests, you can do so by setting the `TEST_REQUEST_RENDERER_CLASSES` setting. -For example, to add support for using `format='yaml'` in test requests, you might have something like this in your `settings.py` file. +For example, to add support for using `format='html'` in test requests, you might have something like this in your `settings.py` file.      REST_FRAMEWORK = {          ...          'TEST_REQUEST_RENDERER_CLASSES': (              'rest_framework.renderers.MultiPartRenderer',              'rest_framework.renderers.JSONRenderer', -            'rest_framework.renderers.YAMLRenderer' +            'rest_framework.renderers.TemplateHTMLRenderer'          )      } | 
