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

2024-04-29

我遇到了一个相当简单的问题,但找到了一些解决方案,并且不停地想知道预期的 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。

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

"product": 1,
"cart": 1

or

"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。
  • 您不必在视图中编写任何自定义逻辑来解析等 - 您可以坚持使用开箱即用的默认通用视图功能

因此,在您的具体情况下,您将通过 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,包括CartProduct对象自己的url在上面的 JSON 中。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

使用 DRF 中序列化器字段的子集反序列化 POST 请求 的相关文章

随机推荐