如何在django-rest-swagger中指定查詢參數序列化程序？

Question

我正在使用Django REST Framework和django-rest-swagger為我的API創建可瀏覽的界面。 我可以使用YAML docstring指定請求正文序列化程序，但我還沒有找到為請求查詢參數指定序列化程序的方法。 我使用的視圖很像：

class ListBans(BaseBanView):

    def get(self, request):
        """
        List all profile bans
        ---
        response_serializer: backend_serializers.BanSerializer
        request_serializer: moderator_serializers.ListBansSerializer
        """
        serializer = moderator_serializers.ListBansSerializer(data=request.query_params)
        if serializer.is_valid(raise_exception=True):
            # query profile bans
            data = []
            return APIResponse(status=status.HTTP_200_OK, data=data)

class ListBansSerializer(serializers.Serializer):
    limit = serializers.IntegerField(default=10, help_text='query limit')
    offset = serializers.IntegerField(default=0, help_text='query offset')

我想要實現的是讓django-rest-swagger為ListBansSerializer查詢參數創建表單字段，這樣我就不必在docstring中手動指定parameters部分。 有沒有辦法做到這一點？

Answer 1

我創建了一個簡單的裝飾器，它自動將查詢參數附加到docstring。 該源可在github上獲得 。 這是一個用法示例：

class ListBansSerializer(serializers.Serializer):
    limit = serializers.IntegerField(default=10, help_text='query limit')
    offset = serializers.IntegerField(default=0, help_text='query offset')


class ListBans(BaseBanView):
    @add_query_parameters(ListBansSerializer)
    def get(self, request):
        """
        List all profile bans
        ---
        response_serializer: backend_serializers.BanSerializer
        """
        serializer = moderator_serializers.ListBansSerializer(data=request.query_params)
        if serializer.is_valid(raise_exception=True):
            # query profile bans
            data = []
            return APIResponse(status=status.HTTP_200_OK, data=data)