REST框架YAML

Django REST Framework的YAML支持

项目的完整文档可在http://jpadilla.github.io/django-rest-framework-yaml找到。

概述

从官方Django REST Framework实现中提取的YAML支持作为第三方软件包。它使用PyYAML软件包构建。

要求

• Python (2.7, 3.3, 3.4)
• Django (1.6, 1.7)

安装

使用pip安装...

$ pip install djangorestframework-yaml

示例

REST_FRAMEWORK = {
    'DEFAULT_PARSER_CLASSES': (
        'rest_framework_yaml.parsers.YAMLParser',
    ),
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework_yaml.renderers.YAMLRenderer',
    ),
}

您还可以使用基于APIView类视图的API来设置用于单个视图或视图集的渲染器和解析器。

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,)

示例输出

---
-
  email: jpadilla@example.com
  is_staff: true
  url: "http://127.0.0.1:8000/users/1/"
  username: jpadilla

文档 & 支持

项目的完整文档可在http://jpadilla.github.io/django-rest-framework-yaml找到。

您还可以在Twitter上关注作者。