django - 如何在 redoc API 文档上自定义 API 端点

Question

我正在使用redocindjango==2.0来记录一些djangoAPI。我注意到默认情况下，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 中填充的，可以在 source 的这个路径中找到["paths"][path][method]["summary"]。您可能需要编辑这些以更改摘要。如果您不想更改源输入，可以在 REDOC 加载后更改 DOM 元素的文本。