为 rest 框架返回的 json 附加元数据

Question

我的模型名为station，根据django rest framework做了API。

class Station(models.Model):
    filter_class = StationFilter
    name = models.CharField(unique=True,max_length=255)
    def __str__(self):
        return self.name

class StationSerializer(serializers.ModelSerializer):
    class Meta:
        model = Station
        fields = ('id','name')

class StationViewSet(viewsets.ModelViewSet):
    queryset = Station.objects.all()
    serializer_class = StationSerializer

现在，它返回这样的Json，对应于表的cols。

{
    [ 
        {id: 1,name:"station1"},
        {id: 2,name:"station2"}
    ]
}

但是我想像这样附加这个 Json 的元数据。

{
    meta : {'time':"2020-02-02 00:00:00:",'apiName:"myapi"},
    items :[ 
        {id: 1,name:"station1"},
        {id: 2,name:"station2"}
    ]
}

有可能吗？或者我该怎么做？？

Answer 1

您需要覆盖 ViewSet 的 list 方法：

class StationViewSet(viewsets.ModelViewSet):
    ...

    def list(self, request, *args, **kwargs):
        custom_data = {
            'list_of_items': StationSerializer(self.get_queryset(), many=true).data  #     this is the default result
        }
        custom_data.update({
            'meta': #your extra data
        })
        return Response(custom_data)

更新：

当您将过滤添加到您的ModelViewSet 时，您应该执行以下操作：

def list(self, request, *args, **kwargs):
    queryset = self.filter_queryset(self.get_queryset())
    custom_data = {
        'list_of_items': self.get_serializer(queryset, many=True).data
    }
    custom_data.update({
        'meta': #your extra data
    })
    return Response(custom_data)