如何在Django Rest Framework JSON API中生成JSON-API数据属性vs结果属性?

Dav*_*son 6 python django django-rest-framework json-api

我有一个使用Django Rest Framework JSON API的django 1.9.2项目:

https://github.com/django-json-api/django-rest-framework-json-api:

我的视图看起来像这样:

class QuestionViewSet(viewsets.ReadOnlyModelViewSet):
    """
    API endpoint that allows questions and answers to be read.
    """
    resource_name = 'questions'
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer
    renderers = renderers.JSONRenderer
    parsers = parsers.JSONParser
Run Code Online (Sandbox Code Playgroud)

典型响应如下:

{"links": {"first": "http://testserver/api/v1/coaches?page=1", "last": "http://testserver/api/v1/coaches?page=1", "next": null, "prev": null}, "results": [{"id": 1, "created": "2016-02-11T02:41:22.569000Z", "updated": null, "deleted": null, "uuid": "0473c709-994f-465b-989e-407c623f365f", "user": {"type": "User", "id": "2"}}, {"id": 2, "created": "2016-02-11T02:41:46.853000Z", "updated": null, "deleted": null, "uuid": "36e19c0e-bda6-4bd7-bc73-374a6fc509d6", "user": {"type": "User", "id": "3"}}, {"id": 3, "created": "2016-02-11T02:42:05.419000Z", "updated": null, "deleted": null, "uuid": "d0798ff4-3be2-4cf3-81ac-edf8049eb075", "user": {"type": "User", "id": "4"}}], "meta": {"pagination": {"page": 1, "pages": 1, "count": 3}}}
Run Code Online (Sandbox Code Playgroud)

我希望输出具有数据属性而不是结果属性.如何告诉DRF JSON API输出此处描述的样式:

http://jsonapi.org/format/

Dav*_*son 1

我的情况的问题是我在视图中有一个视图集派生类,如下所示:

class QuestionViewSet(viewsets.ReadOnlyModelViewSet):
    """
    API endpoint that allows questions and answers to be read.
    """
    resource_name = 'questions'
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer
    renderers = renderers.JSONRenderer
    parsers = parsers.JSONParser
Run Code Online (Sandbox Code Playgroud)

这是错误的。renderers 和 parsers 属性实际上分别是 renderer_classes 和 parser_classes。此外,这些属性的右值是元组,而不是单例。因此:

class QuestionViewSet(viewsets.ReadOnlyModelViewSet):
    """
    API endpoint that allows questions and answers to be read.
    """
    resource_name = 'questions'
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer
    renderer_classes = (renderers.JSONRenderer,)
    parser_classes = (parsers.JSONParser,)
Run Code Online (Sandbox Code Playgroud)

进行此更改后,JSON API 响应基本上是正确的:

{"data":{"type":"questions","id":"1","attributes":{"created":"2016-02-10T04:28:50.742000Z","updated":null,"deleted":null,"uuid":"eddfc27d-2677-49e5-bd37-92fecea340bd","text":"Are you dizzy?"},"relationships":{"answers":{"data":[{"type":"Answer","id":"1"},{"type":"Answer","id":"2"},{"type":"Answer","id":"3"}]},"members":{"data":[{"type":"Member","id":"1"},{"type":"Member","id":"2"},{"type":"Member","id":"3"},{"type":"Member","id":"4"}],"meta":{"count":4}}}}}
Run Code Online (Sandbox Code Playgroud)