如何使用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，而不是在retrieve中。

@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):
        ...