drf-yasg:如何更改 operationId?
drf-yasg: How to change operationId?
如何更改在使用 drf-yasg
时自动出现在 redoc-ui
中的请求的名称。
例如:在图中,你可以看到请求名为fid_data-entities_update
,它是从URL中提取的。
我怎么override/rename呢?
您可以使用 @swagger_auto_schema(...)
decorator to override the operationId
规范作为使用 operation_id
参数
from rest_framework import generics
from rest_framework.response import Response
<b>from drf_yasg.utils import swagger_auto_schema</b>
class OperationIdOverrideAPI(generics.ListAPIView):
<b>@swagger_auto_schema(operation_id="Your awesome name")</b>
def get(self, request, *args, **kwargs):
return Response({"message": "ok"})
如何更改在使用 drf-yasg
时自动出现在 redoc-ui
中的请求的名称。
例如:在图中,你可以看到请求名为fid_data-entities_update
,它是从URL中提取的。
我怎么override/rename呢?
您可以使用 @swagger_auto_schema(...)
decorator to override the operationId
规范作为使用 operation_id
参数
from rest_framework import generics
from rest_framework.response import Response
<b>from drf_yasg.utils import swagger_auto_schema</b>
class OperationIdOverrideAPI(generics.ListAPIView):
<b>@swagger_auto_schema(operation_id="Your awesome name")</b>
def get(self, request, *args, **kwargs):
return Response({"message": "ok"})