如何在Redoc API文档上自定义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

@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"]的此路径中找到。 您可能需要编辑这些内容以更改摘要。 如果您不想更改源输入，可以在REDOC加载后更改DOM元素的文本。