django - 使用 DRF 中序列化器字段的子集反序列化 POST 请求

标签 django django-rest-framework django-views django-serializer

我遇到了一个相当简单的问题,但找到了一些解决方案,并且不停地想知道预期的 DRF 方法是什么。

我有一个(简化的)模型和序列化器,如下所示:

class CartProduct(models.Model):
    cart = models.ForeignKey('Cart', on_delete=models.CASCADE)
    product = models.ForeignKey('Product', on_delete=models.CASCADE)

class CartProductSerializer(serializers.HyperlinkedModelSerializer):
    id = serializers.ReadOnlyField()
    product = ProductSerializer()

    class Meta:
        model = CartProduct
        fields = ('id', 'url', 'product')

这会产生如下所示的 GET 响应:

"url": "http://localhost:8000/appUsers/1/cart/products/16/",
"id": 16,
"product": {
    "url": "http://localhost:8000/products/1/",
    "id": 1,
    "name": "Tomatoes",
},
"cart": "http://localhost:8000/carts/1/"

但是,现在创建新的 CartProduct 时,在这种默认情况下,我需要传递一个类似于上面的嵌套产品字典,以通过 POST 请求创建/反序列化新的 CartProduct。

我想要的是仅使用主键或网址发送带有正文的 POST 请求来创建新的购物车产品,例如像这样:

"product": 1,
"cart": 1

"product": "http://localhost:8000/products/1/"
"cart": "http://localhost:8000/carts/1/"

所以现在我想知道实现这一目标的最佳方法是什么?我想到的是:

  • 编写两个单独的序列化器(但我不喜欢为几乎每个模型都使用两个序列化器的想法)
  • 向每个序列化器添加其他字段,确保嵌套/相关模型始终由 url 和/或 id 表示,并且仅使这些 ID 字段成为必需
  • 重写验证/创建函数以使所需的输入成为有效格式
  • 重写 ModelViewSet 的创建函数并处理其中的问题

处理这种情况最合适的地方是什么?

最佳答案

我更喜欢使用以下方法,其中 1 个模型字段有 2 个序列化器字段(一个用于详细信息的只读字段,一个用于创建和更新的 id/url 字段):

class CartProductSerializer(serializers.HyperlinkedModelSerializer):
    product_detail = ProductSerializer(source='product', read_only=True) 

    class Meta:
        model = CartProduct
        fields = ('url', 'cart', 'product', 'product_detail')

请注意,这假设 ProductSerializer 已在其他地方定义。我省略了 id,因为我们并不真正需要它,但如果您愿意,您仍然可以添加它。

这具有以下优点:

  • 您可以对所有 CRUD 操作使用相同的序列化程序。
  • 您可以通过 GET 获取嵌套字段详细信息,但只能在 POST/PUT 上提供这些嵌套字段的 ID。
  • 您不必在 View 中编写任何自定义逻辑来进行解析等 - 您可以坚持使用开箱即用的默认通用 View 功能

因此,在您的具体情况下,您将通过 GET 返回的 JSON 为:

{
  "url": "http://localhost:8000/appUsers/1/cart/products/16/",
  "product": "http://localhost:8000/products/1/"
  "product_detail": {
    "url": "http://localhost:8000/products/1/",
    "name": "Tomatoes",
  },
  "cart": "http://localhost:8000/carts/1/"
}

对于 POST,您只需发送:

{
  "product": "http://localhost:8000/products/2/"
  "cart": "http://localhost:8000/carts/1/"
}

对于 PUT,请在上述 JSON 中包含 CartProduct 对象自己的 url

关于django - 使用 DRF 中序列化器字段的子集反序列化 POST 请求,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/52758324/

相关文章:

Django Order_by 空白

python - Django - 更改一对多关系中相关对象的值

python - 如何使用 Python/Django 应用程序发送短信?

python - Django 上下文处理器问题

django-rest-framework - 如何在 Django Rest 中隐藏或更改/api/端点的权限?

python - 使用 django REST 进行 LDAP 身份验证

python - 如何将附加数据传递给序列化器?

javascript - Django View 中的通用身份验证

python - django 变量可用于所有 View

django - 如何在不使用表单向导验证表单的情况下转到上一步