Question

我很难理解超链接序列化程序的工作原理。如果我使用普通模型序列化器，它一切正常（返回id等）。但我更愿意返回网址，这是一个更加RESTful的imo。

与我合作的例子看起来非常简单和标准。我有一个API，允许管理员＆＃39;在系统上创建客户（在这种情况下是公司）。客户具有属性＆＃34; name＆＃34;，＆＃34; accountNumber＆＃34;和＆＃34; billingAddress＆＃34;。它存储在数据库的Customer表中。＆＃39;管理员＆＃39;也可以创建客户联系人（客户/公司的人员/联系人）。

创建客户的API为/customer。对此进行POST并且成功后，将在/customer/{cust_id}。

下创建新的Customer资源

随后，用于创建客户联系人的API为/customer/{cust_id}/contact。对此进行POST并且成功后，将在/customer/{cust_id}/contact/{contact_id}下创建新的Customer Contact资源。

我认为这非常简单，是资源导向架构的一个很好的例子。

以下是我的模特：

class Customer(models.Model):
    name = models.CharField(max_length=50)
    account_number = models.CharField(max_length=30, name="account_number")
    billing_address = models.CharField(max_length=100, name="billing_address")

class CustomerContact(models.Model):
    first_name = models.CharField(max_length=50, name="first_name")
    last_name = models.CharField(max_length=50, name="last_name")
    email = models.CharField(max_length=30)
    customer = models.ForeignKey(Customer, related_name="customer")

因此，CustomerContact与客户之间存在外键（多对一）关系。

创建客户非常简单：

class CustomerViewSet(viewsets.ViewSet):
    # /customer POST
    def create(self, request):
        cust_serializer = CustomerSerializer(data=request.data, context={'request': request})
        if cust_serializer.is_valid():
            cust_serializer.save()
            headers = dict()
            headers['Location'] = cust_serializer.data['url']
            return Response(cust_serializer.data, headers=headers, status=HTTP_201_CREATED)
        return Response(cust_serializer.errors, status=HTTP_400_BAD_REQUEST)

创建CustomerContact有点棘手，因为我必须获取客户的外键，将其添加到请求数据并将其传递给序列化程序（我不确定这是否是正确/最好的方式这样做。）

class CustomerContactViewSet(viewsets.ViewSet):
    # /customer/{cust_id}/contact POST
    def create(self, request, cust_id=None):
        cust_contact_data = dict(request.data)
        cust_contact_data['customer'] = cust_id
        cust_contact_serializer = CustomerContactSerializer(data=cust_contact_data, context={'request': request})
        if cust_contact_serializer.is_valid():
            cust_contact_serializer.save()
            headers = dict()
            cust_contact_id = cust_contact_serializer.data['id']
            headers['Location'] = reverse("customer-resource:customercontact-detail", args=[cust_id, cust_contact_id], request=request)
            return Response(cust_contact_serializer.data, headers=headers, status=HTTP_201_CREATED)
        return Response(cust_contact_serializer.errors, status=HTTP_400_BAD_REQUEST)

客户的序列化程序

class CustomerSerializer(serializers.HyperlinkedModelSerializer):
     accountNumber = serializers.CharField(source='account_number', required=True)
    billingAddress = serializers.CharField(source='billing_address', required=True)
    customerContact = serializers.SerializerMethodField(method_name='get_contact_url')

    url = serializers.HyperlinkedIdentityField(view_name='customer-resource:customer-detail')

    class Meta:
        model = Customer
        fields = ('url', 'name', 'accountNumber', 'billingAddress', 'customerContact')

    def get_contact_url(self, obj):
        return reverse("customer-resource:customercontact-list", args=[obj.id], request=self.context.get('request'))

注意（并且可能忽略）customerContact SerializerMethodField（我在Customer资源的表示中返回CustomerContact的URL）。

CustomerContact的序列化程序是：

class CustomerContactSerializer(serializers.HyperlinkedModelSerializer):
    firstName = serializers.CharField(source='first_name', required=True)
    lastName = serializers.CharField(source='last_name', required=True)

    url = serializers.HyperlinkedIdentityField(view_name='customer-resource:customercontact-detail')

    class Meta:
        model = CustomerContact
        fields = ('url', 'firstName', 'lastName', 'email', 'customer')

'customer'是对CustomerContact模型/表中的客户外键的引用。所以当我这样做POST时：

POST http://localhost:8000/customer/5/contact
     body: {"firstName": "a", "lastName":"b", "email":"a@b.com"}

我回来了：

{
    "customer": [
        "Invalid hyperlink - No URL match."
    ]
}

所以外键关系似乎必须在HyperlinkedModelSerializer中表示为URL？ DRF教程（http://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis/#hyperlinking-our-api）似乎也这样说：

Relationships use HyperlinkedRelatedField, instead of PrimaryKeyRelatedField

我可能在我的CustomerContactViewSet中做错了，是将customer_id添加到请求数据中，然后再将它传递给序列化程序（cust_contact_data['customer'] = cust_id）不正确？我尝试从上面的POST示例中传递一个URL - http://localhost:8000/customer/5 - 但是我得到了一个稍微不同的错误：

{
    "customer": [
        "Invalid hyperlink - Incorrect URL match."
    ]
}

如何使用HyperlinkedModelSerializer创建与其他模型具有外键关系的实体？

Answer 1

网址末尾必须包含/：

cust_contact_data['customer'] = 'http://localhost:8000/customer/5/'

这应该有用。

Answer 2

好吧，我在rest_framework挖了一下，似乎不匹配是由于URL模式匹配没有解析到你的相应视图命名空间。在here周围进行一些打印，您可以看到expected_viewname与self.view_name不匹配。

检查您的应用上的视图命名空间是否正确（似乎这些视图位于命名空间customer-resource下），如果需要通过{{修复相关超链接相关字段上的view_name属性Serializer Meta上的1}}：

extra_kwargs

希望这适合你;）

Answer 3

我不确定您是否理解得很好，但是如果您说的是customer_id是主键，那么我认为，如果您在CustomerContactSerializer中指定客户是PrimaryKeyRelatedField，则可以解决问题，例如。

class CustomerContactSerializer(serializers.HyperlinkedModelSerializer):
    firstName = serializers.CharField(source='first_name', required=True)
    lastName = serializers.CharField(source='last_name', required=True)
    customer = serializers.PrimaryKeyRelatedField(
            queryset=Customer.objects.all(),
            many=False)

    class Meta:
        model = CustomerContact
        fields = ('url', 'firstName', 'lastName', 'email', 'customer')

Django（Rest Framework）：使用超链接关系

3 个答案: