Django（Rest Framework）：使用超链接关系创建（POST）嵌套/子资源

Question

我很难理解超链接序列化器的工作方式。如果我使用普通的模型序列化器，则一切正常（返回id等）。但是，我宁愿返回url，这是更RESTful的imo。

我正在使用的示例似乎非常简单和标准。我有一个API，允许“管理员”在系统上创建客户（在这种情况下为公司）。客户具有属性“名称”，“ accountNumber”和“ billingAddress”。这存储在数据库的“客户”表中。“管理员”还能够创建客户联系人（客户/公司的人员/联系人）。

创建客户的API是/customer。对此完成POST并成功后，将在下创建新的Customer资源/customer/{cust_id}。

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

我认为这非常简单，是面向资源的体系结构的一个很好的例子。

这是我的模型：

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和Customer之间存在外键（多对一）关系。

创建客户非常简单：

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有点棘手，因为我必须获取Customer的外键，将其添加到请求数据中，然后将其传递给序列化程序（我不确定这是否是正确/最好的方法）。

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（我以客户资源的形式返回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）是否正确？我尝试通过URL传递http://localhost:8000/customer/5--从上面的POST示例传递给我，但是我得到了一个略有不同的错误：

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

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

Answer 1

/URL末尾必须包含：

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

这应该有效。