简体   繁体   中英

Django Rest Framework: Serializing a model and grouping by a foreign key for other data

I have the following three models:

class Package(models.Model):
  name = models.CharField()

class Part(models.Model):
  name = models.CharField()
  sku = models.IntegerField()

class Member(models.Model):
  name = models.CharField()

class MemberPurchase(models.Model):
  member = models.ForeignKey(Member)
  package = model.ForeignKey(Package)
  part = models.ForeignKey(Part)
  purchase_date = models.DateField()

I want to serialize MemberPurchase model for an API so that I can have all the information I need as below:

{
  "name": "John Doe",
  "id": 123,
  "purchases": [
     {
       "name": "Package Silver",
       "parts": [
          {
            "name": "Part Silver 1",
            "sku": "12345",
          },
          {
            "name": "Part Silver 2",
            "sku": "145678",
          }
       ]
     },
     {
       "name": "Package Gold",
       "parts": [
           {
            "name": "Part Gold 1",
            "sku": "1010101",
          }
       ]
     }
  ]
}

I am not exactly sure how to build the serializer to give me the result above. I can write a serializer that will serialize a queryset from MemberPurchase but that will have a lot of repeated data.

I am guessing this needs multiple serializers:

class MemberSerializer(serializers.ModelSerilaizer):
  purchases = MemberPurchaseSerializer(source='memberpurchase_set', many=True)
  class Meta:
    model = Member
    fields = ['name', 'id']

class MemberPurchaseSerializer(serializers.Serializer):
  name = serializers.SerializerMethodField('get_package_name')
  parts = PackagePartSerializer(many=True)
  def get_pacakage_name(self, instance):
    return instance.package.name

class PackagePartSerializer(serializers.Serializer):
  name = serializers.SerializerMethodField('get_part_name')
  sku = serializers.SerializerMethodField('get_part_sku')
  def get_part_name(self, instance):
    return instance.part.name
  def get_part_sku(self, instance):
    return instance.part.sku

I don't think the above will produce what I need. Is there a better way to do this and get the results above?

Edit: So I decided to take this path but not sure if this is the most efficient implementation:

class PackagePartSerializer(serializers.Serializer):
   name = serializers.SerializerMethodField('get_part_name')
   sku = serializers.SerializerMethodField('get_part_sku')
   def get_part_name(self, instance):
     return instance.part.name
   def get_part_sku(self, instance):
     return instance.part.sku

class MemberSerializer(serializers.ModelSerilaizer):
  purchases = serializers.SerializerMethodField('get_member_purchases')

  def get_member_purchases(self, instance):
    mem_purchases = instance.memberpurchase_set.all()
    purchases = []
    for pur in mem_purchases:
      purchases.append({
        "name": pur.package.name,
        "id": pur.package.id,
        "parts": PackagePartSerializer(instance.memberpurchase_set.all(), many=True).data
      })
    return purchases

  class Meta:
     model = Member
     fields = ['name', 'id', 'purchases']

I am providing the solution I got to as an answer.

class PackagePartSerializer(serializers.Serializer):
   name = serializers.SerializerMethodField('get_part_name')
   sku = serializers.SerializerMethodField('get_part_sku')
   def get_part_name(self, instance):
     return instance.part.name
   def get_part_sku(self, instance):
     return instance.part.sku

class MemberSerializer(serializers.ModelSerilaizer):
  purchases = serializers.SerializerMethodField('get_member_purchases')

  def get_member_purchases(self, instance):
    mem_purchases = instance.memberpurchase_set.all()
    purchases = []
    for pur in mem_purchases:
      purchases.append({
        "name": pur.package.name,
        "id": pur.package.id,
        "parts": PackagePartSerializer(instance.memberpurchase_set.all(), many=True).data
      })
    return purchases

  class Meta:
     model = Member
     fields = ['name', 'id', 'purchases']

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM