Python 如何在django rest swagger中指定查询参数序列化程序?
我正在使用Django REST框架和Django REST swagger为我的API创建可浏览的接口。我可以使用指定请求正文序列化程序,但我还没有找到为请求查询参数指定序列化程序的方法。 我使用的视图非常类似于:Python 如何在django rest swagger中指定查询参数序列化程序?,python,django,django-rest-framework,yaml,Python,Django,Django Rest Framework,Yaml,我正在使用Django REST框架和Django REST swagger为我的API创建可浏览的接口。我可以使用指定请求正文序列化程序,但我还没有找到为请求查询参数指定序列化程序的方法。 我使用的视图非常类似于: class ListBans(BaseBanView): def get(self, request): """ List all profile bans --- response_serializer:
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
为listbanserializer
中的查询参数创建表单字段,这样我就不必在docstring中手动指定parameters
部分。有没有办法做到这一点?我创建了一个简单的装饰程序,可以自动将查询参数附加到docstring中。该资料来源可从以下网址获得:。下面是一个用法示例:
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)