REST Framework YAML
YAML support for Django REST Framework
Full documentation for the project is available at http://jpadilla.github.io/django-rest-framework-yaml.
Overview
YAML support extracted as a third party package directly from the official Django REST Framework implementation. It's built using the PyYAML package.
Requirements
- Python (2.7, 3.3, 3.4)
- Django (1.6, 1.7)
Installation
Install using pip...
$ pip install djangorestframework-yamlExample
REST_FRAMEWORK = {
'DEFAULT_PARSER_CLASSES': (
'rest_framework_yaml.parsers.YAMLParser',
),
'DEFAULT_RENDERER_CLASSES': (
'rest_framework_yaml.renderers.YAMLRenderer',
),
}You can also set the renderer and parser used for an individual view, or viewset, using the APIView class based views.
from rest_framework import routers, serializers, viewsets
from rest_framework_yaml.parsers import YAMLParser
from rest_framework_yaml.renderers import YAMLRenderer
# Serializers define the API representation.
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ('url', 'username', 'email', 'is_staff')
# ViewSets define the view behavior.
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
parser_classes = (YAMLParser,)
renderer_classes = (YAMLRenderer,)Sample output
---
-
email: [email protected]
is_staff: true
url: "http://127.0.0.1:8000/users/1/"
username: jpadillaDocumentation & Support
Full documentation for the project is available at http://jpadilla.github.io/django-rest-framework-yaml.
You may also want to follow the author on Twitter.