如何使用 drf-yasg Swagger 手动自定义 DRF 视图的参数？

Question

我正在使用drf-yasg包将 Swagger 与 DRF 集成。

正如文档所说，我使用@swagger_auto_schema装饰器来手动自定义自动生成的端点。 经过多次尝试，我仍然无法弄清楚为什么没有任何变化。

因此，我尝试向RetrieveUpdateAPIView添加额外的查询参数：

class MyCustomView(RetrieveUpdateAPIView):
    ...

    @swagger_auto_schema(
        manual_parameters=[openapi.Parameter('test', openapi.IN_QUERY, description="test manual param", type=openapi.TYPE_BOOLEAN)]
    )
    def retrieve(self, request, *args, **kwargs):
        ...

毕竟，似乎什么都没有改变。 那我到底要做什么？

Answer 1

您必须在 get 方法中添加swagger_auto_schema而不是检索。

@swagger_auto_schema(
        manual_parameters=[openapi.Parameter('test', openapi.IN_QUERY, description="test manual param", type=openapi.TYPE_BOOLEAN)]
    )
    def get(self, request, *args, **kwargs):
        ...

Answer 2

在 1.18 ( https://github.com/axnsan12/drf-yasg/pull/17 ) 中添加了query_serializer参数。

例子：

    from rest_framework import serializers
    from rest_framework import viewsets
    from drf_yasg.utils import swagger_auto_schema
    
    class CustomParametersSerializer(serializers.Serializer):
        myparam = serializers.CharField(help_text="My manual querystring parameter")

    class MyViewSet(viewsets.ViewSet):
        @swagger_auto_schema(query_serializer=CustomParametersSerializer)
        def my_route(self, request):
            ...