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

Question

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

Answer 1

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

from drf_yasg.utils import swagger_auto_schema
from django.utils.decorators import method_decorator

@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()

Answer 2

Эти сводки фактически заполняются из входного JSON, который можно найти по этому пути в источнике ["paths"][path][method]["summary"]. Возможно, вы захотите отредактировать их, чтобы изменить сводки. Если вы не хотите изменять исходный ввод, попробуйте изменить текст элементов DOM после загрузки REDOC.