Следующее позволяет вам выполнить часть того, что вы просили. Это изменяет описания методов, параметров и ответов ViewSet с помощью swagger_auto_schema в сочетании с 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,)
Обновление
Я обнаружил ошибку, при которой опции operation_summary
и deprecated
, переданные swagger_auto_schema
, фактически игнорируются, поэтому я отправил PR , чтобы исправить это.