Django REST quadro: l'aggiunta di ulteriore campo di ModelSerializer

Question

voglio serializzare un modello, ma di includere un campo aggiuntivo che richiede facendo alcune ricerche nei database nell'istanza modello da serializzato:

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

Qual è la modo giusto per fare questo? Vedo che you can pass in extra "context" per il serializzatore, è la risposta giusta per passare nel campo aggiuntivo in un dizionario di contesto? Con questo approccio, la logica di ottenere il campo di cui ho bisogno non sarebbe autonoma con la definizione di serializzatore, che è l'ideale poiché ogni istanza serializzata avrà bisogno di my_field. Altrove nella documentazione dei serializzatori DRF è says "campi aggiuntivi possono corrispondere a qualsiasi proprietà o chiamabile sul modello". Sono campi extra di cosa sto parlando? Devo definire una funzione nella definizione del modello di Foo che restituisce il valore my_field e nel serializzatore collego my_field a tale chiamabile? Che aspetto ha?

Grazie in anticipo, felice di chiarire la domanda se necessario.

Answer 1

Penso SerializerMethodField è quello che stai cercando:

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

Answer 2

È possibile modificare il metodo del modello in proprietà e utilizzarlo in serializzatore con questo approccio.

Modifica: Con le versioni recenti di rest framework (ho provato 3.3.3), non è necessario modificare la proprietà. Il metodo del modello funzionerà correttamente.

Answer 3

La mia risposta a una domanda simile (here) potrebbe essere utile.

Se si dispone di un metodo del modello definito nel seguente modo:

class MyModel(models.Model): 
    ... 

    def model_method(self): 
     return "some_calculated_result" 

È possibile aggiungere il risultato della chiamata tale metodo al vostro serializzatore in questo modo:

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

P.S. Dal momento che il campo personalizzato non è davvero un campo nel modello, è solitamente desidera rendere di sola lettura, in questo modo:

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

Answer 4

Con l'ultima versione di Django Resto Framework, è necessario creare un metodo nel tuo modello con il nome del campo che vuoi aggiungere. Non è necessario per @property e source='field' generare un errore.

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

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

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