如何使用 swagger_auto_schema 将方法标记为已弃用？

【问题标题】：How to mark a method as deprecated with swagger_auto_schema?如何使用 swagger_auto_schema 将方法标记为已弃用？
【发布时间】：2021-12-27 10:06:01
【问题描述】：

我正在使用 swagger-auto-schema 来记录我的端点 API，使用 django-rest-framework、swagger 和 drf-yasg。有没有办法将文档中的 API 端点标记为已弃用？

【问题讨论】：

标签： python django django-rest-framework swagger drf-yasg

【解决方案1】：

您应该在 swagger_auto_schema 装饰器上设置deprecated=True 参数。

例子：

class MyViewSet(viewsets.ModelViewSet):
    ...

    @swagger_auto_schema(deprecated=True)
    def list(self, request, *args, **kwargs):
        return super().list(request, *args, **kwargs)

【讨论】：