drf-yasg：如何更改 operationId？

Question

使用 drf-yasg 时如何更改 redoc-ui 中自动出现的请求的名称。

例如：在图像中，您可以看到请求名为 fid_data-entities_update，它是从 URL 中提取的。

如何覆盖/重命名它？

Answer 1

您可以使用@swagger_auto_schema(...)装饰器来覆盖operationId规范，就像使用operation_id参数一样

from rest_framework import generics
from rest_framework.response import Response
from drf_yasg.utils import swagger_auto_schema


class OperationIdOverrideAPI(generics.ListAPIView):

    @swagger_auto_schema(operation_id="Your awesome name")
    def get(self, request, *args, **kwargs):
        return Response({"message": "ok"})