django rest 框架 - 通过单个 API 调用创建具有外键的资源答案

【问题标题】：django rest framework - create a resource that has foreign keys with a single API calldjango rest 框架 - 通过单个 API 调用创建具有外键的资源
【发布时间】：2015-03-18 02:55:46
【问题描述】：

我在创建“估算”资源时遇到问题。基本上，我想要实现的是进行单个 API 调用来创建一个“Estimate”实例，该实例具有 3 个外键，并且更愿意使用 ModelViewSet 来利用它附带的所有方法（POST，获取、放置、删除、补丁）。

例子：

使用以下数据进行一次 POST 调用： {用户：，属性：，估计类型：，消息：“测试消息”} /api/estimates/

我设法配置 API 以检索我需要的所有详细信息，“用户”对象详细信息除外，而我只获取 URL，但我想这没关系，因为我可以获取用户详细信息单独调用。

我有点困惑，想了解通过一次调用创建“Estimate”实例的正确方法是什么。我应该覆盖“Estimate”类的保存方法吗？

非常感谢所有建议。

Django==1.7.6 djangorestframework==3.1.0

这些是我的模型：

class Property(models.Model):
    user         = models.ForeignKey(User)
    address      = models.CharField(max_length=100)

def __str__(self):
    return self.address


class EstimateType(models.Model):
    name          = models.CharField(max_length=100)

def __str__(self):
    return self.name

class Estimate(models.Model):
    user          = models.ForeignKey(User)
    property      = models.ForeignKey(Property)
    estimate_type = models.ForeignKey(EstimateType)
    message       = models.TextField(max_length=144)

def __str__(self):
    return "{} {}".format(self.user.username, self.property.address1)

这些是序列化程序：

class UserSerializer(serializers.HyperlinkedModelSerializer):

class Meta:
    model = User
    fields = ('pk','username', 'email','first_name', 'last_name', 'is_staff')

class PropertySerializer(serializers.ModelSerializer):
    user = UserSerializer()

    class Meta:
        model = Property
        fields = ('pk','address','user')

class EstimateTypeSerializer(serializers.ModelSerializer):

    class Meta:
        model = EstimateType
        fields = ('pk', 'name')

class EstimateSerializer(serializers.HyperlinkedModelSerializer):
    property = PropertySerializer()
    service  = EstimateTypeSerializer()

class Meta:
    model = Estimate
    fields = ('pk','user','property','service', 'message')

视图集：

class UserViewSet(viewsets.ModelViewSet):
    queryset         = User.objects.all()
    serializer_class = UserSerializer

class PropertyViewSet(viewsets.ModelViewSet):
    queryset         = Property.objects.all()
    serializer_class = PropertySerializer

class EstimateTypeViewSet(viewsets.ModelViewSet):
    queryset         = EstimateType.objects.all()
    serializer_class = EstimateTypeSerializer

class EstimateViewSet(viewsets.ModelViewSet):

    serializer_class = EstimateSerializer

    def get_queryset(self):
        queryset = Estimate.objects.filter(user=self.request.user)
        return queryset

发送 GET 请求到 /api/估计/

检索以下内容：

    [
  {
    "pk": 3,
    "user": "http://localhost:8000/users/2/",
    "property": {
      "pk": 3,
      "address": “123 Fake street",
      "user": {
        "pk": 2,
        "username": “admin”,
        "email": “admin@foo.com”,
        "first_name": “Foo”,
        "last_name": “Bar”,
        "is_staff": true
      }
    },
    “estimate_type”: {
      "pk": 1,
      "name": “basic”
    },
    "message": "Lorem Ipsum is simply dummy text of the printing and typesetting \n”
  }
]

【问题讨论】：

标签： django api rest

【解决方案1】：

要创建一个链接到其他现有记录的新 Estimate，您只需发送一个像这样的对象，只有主键标识相关对象：

{
    "user": <user pk>,
    "property": <property pk>,
    "estimate_type": <estimate type pk>,
    "message": "foo bar"
}

restframework 2.x 不支持写入嵌套序列化程序 - 正如你所做的那样。

看看如何创建一个可写的 RelatedField 类：http://www.django-rest-framework.org/api-guide/relations/#custom-relational-fields

【讨论】：