Как настроить конечные точки API в документации Redoc API - PullRequest
Новая
       95

Как настроить конечные точки API в документации Redoc API

0 голосов
/ 28 марта 2019

Я использую redoc в django==2.0 для документирования некоторых django API.Я заметил, что по умолчанию redoc будет называть конечные точки автоматически, как вы можете видеть на изображении ниже с левой стороны.Скорее всего, я не хочу использовать сгенерированные имена, которые я хочу изменить.От кого-то, кто имеет опыт работы с redoc документацией, не могли бы вы посоветовать?

enter image description here

1 Ответ

0 голосов
/ 10 июля 2019

Если вы используете drf-yasg, вы можете использовать декоратор swagger_auto_schema для настройки operation_id. 

from drf_yasg.utils import swagger_auto_schema

@method_decorator(name='get', decorator=swagger_auto_schema(operation_id='List Widgets', operation_description='List all available widgets'))
class WidgetListView(ListAPIView):
    serializer_class = WidgetSerializer

    def get_queryset(self):
        return Widget.objects.all()
...