3

我可以通过评论视图集自定义招摇描述吗？我使用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')

我想在这里添加描述： 在此处输入图像描述

我该怎么做？

4

1 回答 1

1

以下允许您实现您所要求的部分内容。通过使用swagger_auto_schema和Django 的 method_decorator来改变 ViewSet 的方法、参数和响应的描述。

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

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,)

更新

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

于 2018-08-30T12:19:51.487 回答