python - 在评论中添加招摇描述

Question

我可以通过评论 View 集自定义 swagger 描述吗？我用drf-yasg .

我的代码:

class MetricViewSet(viewsets.ReadOnlyModelViewSet):
    """
       retrieve:
       Получить из справочника данные записи о метрике по *uuid*

       list:
       Получить из справочника коллекцию записей о метриках
    """
    lookup_field = 'uuid'
    serializer_class = MetricSerializer
    queryset = Metric.objects.all()
    permission_classes = (ApiPermission,)

我的序列化器

class MetricSerializer(serializers.ModelSerializer):
    """
        Metric serializer.
    """
    uuid = serializers.UUIDField(label='Global UUID', read_only=True)

    class Meta:  # pylint: disable=too-few-public-methods
        """
            Настройки сериализатора
        """
        model = Metric
        fields = ('uuid', 'creation_date', 'modify_date',
                  'name', 'description', 'enabled', 'comment')

我想在这里添加描述:

我该怎么做？

Answer 1

以下内容可以让您实现您所要求的部分内容。即通过使用 swagger_auto_schema 更改 ViewSet 的方法、参数和响应的描述。与 Django's method_decorator 结合.

检查两个链接以获取更多信息。

from rest_framework import viewsets
from drf_yasg import openapi
from drf_yasg.utils import swagger_auto_schema

@method_decorator(name='retrieve', decorator=swagger_auto_schema(
    operation_description="Method description",
    operation_id="Method ID",
    operation_summary="Method summary",
    manual_parameters=[
        openapi.Parameter('serial', in_=openapi.IN_PATH, type=openapi.TYPE_STRING, description='Parameter description')
    ],
    responses={'200': 'Response description'}
))
class MetricViewSet(viewsets.ReadOnlyModelViewSet):
    """
       retrieve:
       Получить из справочника данные записи о метрике по *uuid*

       list:
       Получить из справочника коллекцию записей о метриках
    """
    lookup_field = 'uuid'
    serializer_class = MetricSerializer
    queryset = Metric.objects.all()
    permission_classes = (ApiPermission,)

<小时/>

更新

我发现了一个错误，其中传递给 swagger_auto_schema 的 operation_summary 和 deprecated 选项实际上被忽略，所以我提交了此 PR来解决这个问题。