Блог

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

Если вы используете 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()
  

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