如何改变 ModelViewSet 呈现数据的方式？

Question

我的 api 有两个序列化程序，可以为我提供有关公司办公地点的数据。

class CountryFilialsSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = CountryFilials
        fields = ['name']

class FilialsSerializer(serializers.HyperlinkedModelSerializer):
    country = CountryFilialsSerializer()
    class Meta:
        model = Filials
        fields = ['country', 'name', 'subdomain_name', 'address']

CountryFilialsSerializer 通过外键给我带来国家名称，FilialsSerializer 将此数据添加到其他子数据中。

目前使用它们的视图如下所示：

class FilialsViewSet(viewsets.ModelViewSet):
    queryset = Filials.objects.all()
    serializer_class = FilialsSerializer

它返回如下所示的响应：

"results": [
        {
            "country": {
                "name": "foo"
            },
            "name": "city1",
            "subdomain_name": "subdomain1",
            "address": "location1"
        },
        
        {
            "country": {
                "name": "foo"
            },
            "name": "city2",
            "subdomain_name": "subdomain2",
            "address": "location2"
        },

但我需要它来实际呈现这样的结果：

[
  {
    "country": "foo",
    "cities": [
      {
        "name": "city1",
        "subdomain_name": "subdomain1",
        "address": "location1"
      },
      {
        "name": "city2",
        "subdomain_name": "subdomain2",
        "address": "location2"
      },
    ]
  },
]

基本相同的数据，只是按国家/地区分组到列表中。

我想不出办法来做到这一点。 正如我所意识到的，序列化程序一次只从基础接收一个条目，如果我覆盖它的to_representation()方法以包含 output 的一些格式，我将无法访问多个位置并将它们按一个国家/地区分组。 我的下一个猜测是应该有类似的方法直接从视图中处理结果。 但是我在文档中找不到任何相关信息（或者我什至不知道该找什么）。 找到了一些有关操作和 update() 方法的信息，但无法了解如何将其用于我的目标。 你能建议点什么吗？ 我不知道在哪里以及如何将逻辑放入视图中，以便能够捕获它推入响应中的所有内容并重新组织它。

Answer 1

您可以拥有这样的城市的国家/地区列表（这需要您使用CountryFilialsViewset更改视图）

class FilialsSerializer(serializers.ModelSerializer):
    class Meta:
        model = Filials
        fields = ['name',]

class CountryFilialsSerializer(serializers.ModelSerializer):
    filials = FilialsSerializer(many=True, read_only=True)
    class Meta:
        model = CountryFilials
        fields = ['name', 'filials']

class CountryFilialsViewSet(viewsets.ModelViewSet):
    queryset = CountryFilials.objects.prefetch_related('filials')
    serializer_class = CountryFilialsSerializer

或者，如果您需要重写ModelViewSet ，您可以这样做：

class CountryFilialsViewSet(viewsets.ModelViewSet):
    queryset = CountryFilials.objects.prefetch_related('filials_set')
    serializer_class = CountryFilialsSerializer

    def list(self, request):
        response = [
            {'country': country.name, 'cities': list(country.filials_set.values('name').all())} for country in CountryFilials.objects.all()
        ]
        return Response(response)

编辑：将filials更改为filials_set

以下是有关如何更改字段名称和数据的示例：

class FilialsSerializer(serializers.ModelSerializer):
    url = serializers.SerializerMethodField('get_url')
    class Meta:
        model = Filials
        fields = ['name', 'url', 'address']

    def get_url(self, obj):
        # construct the url
        return  f'http://{obj.subdomain_name}.example.com/api/v1/cities/'

class CountryFilialsSerializer(serializers.ModelSerializer):
    filials = FilialsSerializer(many=True, read_only=True, source='filials_set')
    class Meta:
        model = CountryFilials
        fields = ['name', 'filials']

class CountryFilialsViewSet(viewsets.ModelViewSet):
    queryset = CountryFilials.objects.prefetch_related('filials_set')
    serializer_class = CountryFilialsSerializer

您将使用CountryFilialsViewSet获得所需的结果。 例如在你的urls.py你会有

router = routers.DefaultRouter()
router.register(r'filials', CountryFilialsViewSet),

urlpatterns = [
    path('', include(router.urls)),
]

调用http://api/filials将产生响应。