Django REST framework モデルをserializeした後にデータを加工し、加工後のデータをレスポンスしたい

Question

djangoとrest_frameworkを用いてapiを作成しております。

api作成の手順として

modelの定義
↓
serializerの定義
↓
viewsetの定義
↓
api_urlのルーティング

　
だと思うのですが、データベースのデータをそのまま渡すのではなく、データを使って何かしらの処理をした後のデータをレスポンスとして与えたいと考えております。seriarizerもしくはviewsetに記述するとは思うのですが、加工した後のデータをどうやって再度シリアライズすればいいのかが分かりません。
全く的外れなことを言っているかもしれません。
これを実現するにはどうすれば良いでしょうか？また、実現しようとしていることが好ましくない場合はどのような対応をすれば良いでしょうか？

例

# viewset
class TaskViewSet(ReadOnlyModelViewSet):
    queryset = Task.objects.all()
    # 例えば取得したquerysetの統計情報を計算してそれをresponseに与えたい
    # クライアント側ですべきか？
    serializer_class = TaskSerializer

# serializer
class TaskSerializer(serializers.ModelSerializer):
    class Meta:
        model = Task
        fields = (
            'id',
            'uid',
            'date',
            'task',
        )

Answer 1

querysetの統計情報が具体的にどういうものかわかりませんが、単純にTaskSerializerにデータを加えたいのであれば、Serializer に SerializerMethodField を生やして任意のデータを加えるという手はあると思います。

# serializer
class TaskSerializer(serializers.ModelSerializer):
    class Meta:
        model = Task
        fields = (
            'id',
            'uid',
            'date',
            'task',
            'toukei_data',
        )

    toukei_data = serializers.SerializerMethodField()

    def get_toukei_data(self, obj):
        return # 好きなデータを返すと、JSON の toukei_data にデータが加わる

参考: https://www.django-rest-framework.org/api-guide/fields/#serializermethodfield

他にやりようがあるとすれば、例えば、ViewSet の listメソッド を overrideしてレスポンス内容を書き換えるとかも可能だとは思います。

参考: https://www.django-rest-framework.org/api-guide/viewsets/#modelviewset

Comments

[_Victorique__]

回答有難うございます。
なるほどget_*()を実装することでfieldに*を追加することができるのですね。
ということは、fieldにその他を書かなければ追加したものだけレスポンスとして与えられるという認識で合っていますでしょうか？

[tell_k]

その認識であってると思います。

[_Victorique__]

あーもしかして、serializerでは全て記述しておいて、viewsetでdjango_filterを用いてフィルタリングするような使い方が一般的でしょうか？

[tell_k]

django_filter はデータの検索条件を指定するやつなので、今回のように追加でデータを加えたいみたいなケースには使えないと思いますね。例) GETパラメータで hoge=1 渡したら、テーブルのなかから hoge==1のデータだけをfilterする。

[_Victorique__]

ほんとですね。
では用途に合わせたserializerを作らないといけないということで合ってますか？

[tell_k]

はい。Modelに存在しないデータはSerializerで別途付与してあげるのが良いと思います。

[_Victorique__]

有難うございました！