如何在 django-rest-swagger 中指定查询参数序列化程序

Question

我正在使用带有django-rest-swagger的Django REST框架为我的API创建可浏览的界面。我可以使用 YAML 文档字符串指定请求正文序列化程序，但我还没有找到为请求查询参数指定序列化程序的方法。我使用的视图非常像：

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查询参数创建表单字段，这样我就不必在文档字符串中手动指定parameters部分。有没有办法做到这一点？

Answer 1

我创建了一个简单的装饰器，可以自动将查询参数附加到文档字符串中。源代码可在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)