Django REST Framework - 在 URL 中添加 2 个 PK

Question

我正在为同时拥有公司和部门的应用程序设计 REST API。一定数量的用户可以是公司的成员。这导致了以下 API 结构：

/companies/ - 可以获取，发布。

/companies/<pk>/ - 可以获取、发布、放置、修补、删除。

/companies/<pk>/membership/ - 可以 GET（提供公司成员的所有用户）、POST。

/companies/<pk>/membership/<pk>/ - 可以删除。

我已经设法实现了前 3 个端点，但是在实现最后一个端点时遇到了麻烦——如何实现<pk>在 URL中有多个值的端点？这是我到目前为止所拥有的：

目前在api应用程序中有一个 urls.py 文件，如下所示：

...
    url(r'^company', include(company_urls.company_router.urls,
    namespace="company")),
...

urls.py在company应用程序中。

from rest_framework import routers

from .views import CompanyViewSet


company_router = routers.DefaultRouter()

company_router.register(r'^', CompanyViewSet)

serializers.py 文件：

from rest_framework import serializers

from .models import Company, CompanyMembership
from My_App.users.models import Profile


class CompanySerializer(serializers.ModelSerializer):

    class Meta:
        model = Company
        fields = ('pk', 'name', 'departments', 'members')
        read_only_fields = ('pk', 'departments', 'members')


class CompanyMembershipSerializer(serializers.Serializer):
    user = serializers.PrimaryKeyRelatedField(queryset=Profile.objects.all())

    def create(self, validated_data):
        pass

    def delete(self, instance, validated_data):
        pass

和 views.py 文件：

from .models import Company, CompanyMembership
from .serializers import CompanySerializer, CompanyMembershipSerializer

from My_Appc.users.models import Profile


class CompanyViewSet(viewsets.ModelViewSet):
    queryset = Company.objects.all()
    serializer_class = CompanySerializer

    @decorators.detail_route(methods=['get', 'post', 'delete'])
    def membership(self, request, pk):
        company = self.get_object()
        if request.method == 'GET':
            serializer = CompanyMembershipSerializer(company)
        elif request.method == 'POST':

            serializer = CompanyMembershipSerializer(data=request.data)
            if serializer.is_valid():
                try:
                    user = Profile.objects.get(pk=request.data.get('user'))
                    user_company_membership = CompanyMembership(user=user,
                                                                company=company)
                    user_company_membership.save()
                    return Response({'status': 'User added to Company.'},
                                    status=status.HTTP_201_CREATED)
                except IntegrityError:
                    result = {
                        'status': 'Failed to add user to Company.',
                        'reason': 'User already part of Company.'
                    }
                    status=settings.ADDITIONAL_HTTP_STATUS_CODES[
                        '422_UNPROCESSABLE_ENTITY']
                    return Response(result, status)
            else:
                return Response(serializer.errors,
                                status=status.HTTP_400_BAD_REQUEST)

Answer 1

对 url 中的参数使用不同的名称：

/companies/<company_pk>/membership/<membership_pk>/

并在您的 ViewSet 添加lookup_field并lookup_url_kwarg指向公司 pk 字段/参数：

class CompanyViewSet(viewsets.ModelViewSet):
    lookup_field = 'pk'
    lookup_url_kwarg = 'company_pk'

get_object 方法使用这两个查找来过滤查询集，因此您将根据 url 中的第一个 pk 获得公司。

在您管理会员对象的会员方法和自定义逻辑中，您可以通过以下方式访问会员 pk：

membership_pk = self.kwargs.get('membership_pk', None)