Django REST Framework: การเพิ่มฟิลด์เพิ่มเติมใน ModelSerializer

ฉันต้องการทำให้เป็นอนุกรมรุ่น แต่ต้องการรวมเขตข้อมูลเพิ่มเติมที่ต้องทำการค้นหาฐานข้อมูลบางอย่างในอินสแตนซ์รูปแบบที่จะต่อเนื่อง:

class FooSerializer(serializers.ModelSerializer):
  my_field = ... # result of some database queries on the input Foo object
  class Meta:
        model = Foo
        fields = ('id', 'name', 'myfield')

วิธีที่ถูกต้องในการทำเช่นนี้คืออะไร? ฉันเห็นว่าคุณสามารถส่งต่อใน "บริบท" พิเศษเพื่อ serializer เป็นคำตอบที่ถูกต้องในฟิลด์เพิ่มเติมในพจนานุกรมบริบทหรือไม่ ด้วยวิธีการที่ตรรกะของการได้รับข้อมูลที่ฉันต้องการจะไม่เป็นตนเองมีความหมาย serializer my_fieldซึ่งเหมาะเป็นอย่างยิ่งตั้งแต่ทุกกรณีจะต้องต่อเนื่อง ที่อื่นในเอกสาร DRF serializers มันบอกว่า "เขตข้อมูลพิเศษสามารถสอดคล้องกับคุณสมบัติใด ๆ หรือ callable ในรูปแบบ" ฟิลด์พิเศษที่ฉันกำลังพูดถึงคืออะไร ฉันควรกำหนดฟังก์ชั่นในการFooกำหนดรูปแบบของที่คืนmy_fieldค่าและใน serializer ฉันขอ my_field เพื่อ callable ที่? มันมีลักษณะอย่างไร

ขอบคุณล่วงหน้ายินดีที่จะชี้แจงคำถามหากจำเป็น

ฉันคิดว่า SerializerMethodField คือสิ่งที่คุณกำลังมองหา:

class FooSerializer(serializers.ModelSerializer):
  my_field = serializers.SerializerMethodField('is_named_bar')

  def is_named_bar(self, foo):
      return foo.name == "bar" 

  class Meta:
    model = Foo
    fields = ('id', 'name', 'my_field')

http://www.django-rest-framework.org/api-guide/fields/#serializermethodfield

คุณสามารถเปลี่ยนรูปแบบวิธีการเป็นคุณสมบัติและใช้ใน serializer ด้วยวิธีนี้

class Foo(models.Model):
    . . .
    @property
    def my_field(self):
        return stuff
    . . .

class FooSerializer(ModelSerializer):
    my_field = serializers.ReadOnlyField(source='my_field')

    class Meta:
        model = Foo
        fields = ('my_field',)

แก้ไข: ด้วยเฟรมเวิร์กพักผ่อนล่าสุด (ฉันลอง 3.3.3) คุณไม่จำเป็นต้องเปลี่ยนเป็นคุณสมบัติ วิธีการสร้างแบบจำลองจะทำงานได้ดี

ด้วย Django Rest Framework เวอร์ชันล่าสุดคุณต้องสร้างวิธีในโมเดลของคุณด้วยชื่อของฟิลด์ที่คุณต้องการเพิ่ม ไม่ต้องการ@propertyและsource='field'เพิ่มข้อผิดพลาด

class Foo(models.Model):
    . . .
    def foo(self):
        return 'stuff'
    . . .

class FooSerializer(ModelSerializer):
    foo = serializers.ReadOnlyField()

    class Meta:
        model = Foo
        fields = ('foo',)

การตอบคำถามที่คล้ายกันของฉัน ( ที่นี่ ) อาจมีประโยชน์

หากคุณมีการกำหนดวิธีการแบบด้วยวิธีต่อไปนี้:

class MyModel(models.Model):
    ...

    def model_method(self):
        return "some_calculated_result"

คุณสามารถเพิ่มผลลัพธ์ของการโทรวิธีดังกล่าวไปยังซีเรียลไลเซอร์ได้ดังนี้:

class MyModelSerializer(serializers.ModelSerializer):
    model_method_field = serializers.CharField(source='model_method')

ป.ล. เนื่องจากฟิลด์ที่กำหนดเองไม่ใช่ฟิลด์ในโมเดลของคุณคุณมักจะต้องการให้เป็นแบบอ่านอย่างเดียวเช่น:

class Meta:
    model = MyModel
    read_only_fields = (
        'model_method_field',
        )

ถ้าคุณต้องการอ่านและเขียนในเขตข้อมูลพิเศษของคุณคุณสามารถใช้ serializer ที่กำหนดเองใหม่ที่ขยาย serializers.Serializer และใช้มันเช่นนี้

class ExtraFieldSerializer(serializers.Serializer):
    def to_representation(self, instance): 
        # this would have the same as body as in a SerializerMethodField
        return 'my logic here'

    def to_internal_value(self, data):
        # This must return a dictionary that will be used to
        # update the caller's validation data, i.e. if the result
        # produced should just be set back into the field that this
        # serializer is set to, return the following:
        return {
          self.field_name: 'Any python object made with data: %s' % data
        }

class MyModelSerializer(serializers.ModelSerializer):
    my_extra_field = ExtraFieldSerializer(source='*')

    class Meta:
        model = MyModel
        fields = ['id', 'my_extra_field']

ฉันใช้สิ่งนี้ในฟิลด์ที่ซ้อนกันที่เกี่ยวข้องกับตรรกะที่กำหนดเอง

สิ่งนี้ใช้ได้ผลสำหรับฉัน หากเราต้องการเพิ่มเขตข้อมูลเพิ่มเติมใน ModelSerializer เราสามารถทำเช่นนี้ได้ด้านล่างและเขตข้อมูลสามารถกำหนดค่าบางค่าได้หลังจากการคำนวณการค้นหาบางอย่าง หรือในบางกรณีถ้าเราต้องการส่งพารามิเตอร์ในการตอบสนอง API

ใน model.py

class Foo(models.Model):
    """Model Foo"""
    name = models.CharField(max_length=30, help_text="Customer Name")



   **

ใน serializer.py

**

class FooSerializer(serializers.ModelSerializer):
    retrieved_time = serializers.SerializerMethodField()

    @classmethod
    def get_retrieved_time(self, object):
        """getter method to add field retrieved_time"""
        return None

  class Meta:
        model = Foo
        fields = ('id', 'name', 'retrieved_time ')

**

หวังว่านี่จะช่วยคนได้

**

ตามที่นักเขียนโปรแกรมเคมีกล่าวไว้ในความคิดเห็นนี้ใน DRF ล่าสุดคุณสามารถทำสิ่งนี้ได้:

class FooSerializer(serializers.ModelSerializer):
    extra_field = serializers.SerializerMethodField()

    def get_extra_field(self, foo_instance):
        return foo_instance.a + foo_instance.b

    class Meta:
        model = Foo
        fields = ('extra_field', ...)

แหล่งเอกสาร DRF