如何在Django REST Framework中实现资源层次结构（例如/ parents /< id> / children） [英] How to implement a hierarchy of resources (eg. /parents/<id>/children) in Django REST Framework

问题描述

在Django REST Framework网站的教程中，我找不到任何有关如何实现这一点的信息，而且我还没有在文档中找到它，尽管我确定它在某处。

I couldn't find any information on how to achieve this in the tutorial at the Django REST Framework website and I haven't managed to find it in the documentation, though I'm sure it's there somewhere.

我想要问题成为父资源，页成为孩子，以便 / issues / 1 / pages 返回所有页面， issue_id 为1。

I want issues to be the parent resource and pages to be the children so that /issues/1/pages returns all pages with issue_id of 1.

有没有一个很好的方法来实现这个使用泛型类视图？

Is there a good way to achieve this using generic class based views?

这是我到目前为止。

restAPI / urls.py：

from django.conf.urls import patterns, url
from rest_framework.urlpatterns import format_suffix_patterns
from restAPI import views

urlpatterns = patterns('',
    url(r'^issues/$', views.IssueList.as_view()),
    url(r'^issues/(?P<pk>[0-9]+)/$', views.IssueDetail.as_view()),


    url(r'^issues/(?P<issue_id>[0-9]+)/pages/$', views.PageList.as_view()),    
    url(r'^pages/(?P<pk>[0-9]+)/$', views.PageDetail.as_view()),
)

urlpatterns = format_suffix_patterns(urlpatterns)

restAPI / models.py：

from django.db import models

class Issue(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    revision = models.IntegerField(default = 1)
    issue_date = models.DateTimeField(auto_now_add=True)
    issue_image_url = models.CharField(max_length=100)

class Page(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    page_number = models.IntegerField()
    standard_page_url = models.CharField(max_length=100, default='')
    large_page_url = models.CharField(max_length=100, default='')
    thumbnail_url = models.CharField(max_length=100, default='')

    issue = models.ForeignKey(Issue, related_name="pages")

    class Meta:
        ordering = ('page_number',)

restAPI / serializers.py：

from rest_framework import serializers
from restAPI.models import Page, Issue

class IssueSerializer(serializers.ModelSerializer):
    class Meta:
        model = Issue
        fields = ('id', 'created', 'revision', 'issue_date', 'issue_image_url')

class PageSerializer(serializers.ModelSerializer):       
    class Meta:
        model = Page
        fields = ('id', 'created', 'page_number', 'standard_page_url', 'large_page_url', 'thumbnail_url')

restAPI / views.py：

from restAPI.models import Page, Issue
from restAPI.serializers import PageSerializer, IssueSerializer
from rest_framework import mixins
from rest_framework import generics

class IssueList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Issue.objects.all()
    serializer_class = IssueSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

class IssueDetail(mixins.RetrieveModelMixin,
                    mixins.UpdateModelMixin,
                    mixins.DestroyModelMixin,
                    generics.GenericAPIView):
    queryset = Issue.objects.all()
    serializer_class = IssueSerializer

    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

    def delete(self, request, *args, **kwargs):
        return self.destroy(request, *args, **kwargs)  

class PageList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Page.objects.all()
    serializer_class = PageSerializer

    def get(self, request, *args, **kwargs):
        print kwargs
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

class PageDetail(mixins.RetrieveModelMixin,
                   mixins.UpdateModelMixin,
                   mixins.DestroyModelMixin,
                   generics.GenericAPIView):
    queryset = Page.objects.all()
    serializer_class = PageSerializer

    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

    def delete(self, request, *args, **kwargs):
        return self.destroy(request, *args, **kwargs)

如何在问题和<$ c $之间实现这种关系c>页面？

推荐答案

这是另一种做法：

views.py

from models import Customer, Order
from serializers import CustomerSerializer, OrderSerializer

from rest_framework import generics

class CustomerList(generics.ListCreateAPIView):
    queryset = Customer.objects.all()
    serializer_class = CustomerSerializer

class CustomerDetail(generics.RetrieveUpdateDestroyAPIView)
    queryset = Customer.objects.all()
    serializer_class = CustomerSerializer

class OrdersByCustomer(generics.ListCreateAPIView):
    queryset = Order.objects.all()
    serializer_class = OrderSerializer

    def get_queryset(self):
        customer_pk = self.kwargs['customer_pk']
        return self.queryset.filter(customer__pk=customer_pk)

    def pre_save(self, obj):
        obj.customer_id = self.kwargs['customer_pk'] 

class OrderDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Order.objects.all()
    serializer_class = OrderSerializer

serializers.py

from models import Customer, Order

from rest_framework import serializers
from rest_framework.reverse import reverse

class OrderSerializer(serializers.HyperlinkedModelSerializer)

    class Meta:
        model = Order

class CustomerSerializer(serializers.HyperlinkedModelSerializer)

    orders = serializers.SerializerMethodField('get_customer_orders')

    def get_customer_orders(self, obj):
        return reverse('ordersbycustomer-list', 
               args=[obj.pk], request=self.context['request'])

    class Meta:
        model = Customer

urls.py

from django.conf.urls import patterns, include, url
from views import OrdersByCustomer, CustomerDetail, CustomerList

urlpatterns = patterns("",
    url(r'^customers/(?P<customer_pk>.+)/orders/$', OrdersByCustomer.as_view(), name='ordersbycustomer-list'),
    url(r'^customers/(?P<pk>.+)/$', CustomerDetail.as_view(), name='customer-detail'),
    url(r'^customers/$', CustomerList.as_view(), name='customer-list'),
    )

与Viewsets / Routers相比，有更多的代码但这样可以更好地控制正在发生的事情。

There is more code involved than with Viewsets/Routers but this gives you much more control over what is going on.

这里我选择只将订单作为客户的孩子公开。由于它们是分开的，您可以使用不同的序列化器类列表vs细节。

Here I have chosen to only expose orders as children of a customer. Since they are separated, you can use different serializer classes for list vs detail.

这篇关于如何在Django REST Framework中实现资源层次结构（例如/ parents /&lt; id&gt; / children）的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！