如何将 swagger API 端点（基于函数的视图）与 drf_yasg 分组 - Django

Question

我正在做一些从 Django 1.11 --> 3.1.5 的迁移工作

之前用“rest_framework_swagger”，我在url.py

中就可以通过这个实现swagger api分组

url(r'^api/v9/test_token1$', 
    api.test_token, 
    name='test_token'),

url(r'^api/v9/test_token2$', 
    api.test_token, 
    name='test_token'),

并得到这个（注意它分组 v9）

但是，我在 Django 3.1.5 上尝试使用“drf_yasg” url.py

path('/v2/token_api1', token_api1, name='token_api1'),
path('/v2/token_api2', token_api2, name='token_api2'),

我的api定义（请注意我使用的是@api_view）

token = openapi.Parameter('token', openapi.IN_FORM, type=openapi.TYPE_STRING, required=True)
@swagger_auto_schema(
    method="post",
    manual_parameters=[token],
    operation_id="token_api1"
)
@api_view(['POST'])
# this is optional and insures that the view gets formdata
@parser_classes([FormParser])
def token_api1(request):
    token = request.POST['token']    
    return Response("success test_api:" + token, status=status.HTTP_200_OK)


token = openapi.Parameter('token', openapi.IN_FORM, type=openapi.TYPE_STRING, required=True)
@swagger_auto_schema(
    method="post",
    manual_parameters=[token],
    operation_id="token_api2"
)
@api_view(['POST'])
# this is optional and insures that the view gets formdata
@parser_classes([FormParser])
def token_api2(request):
    token = request.POST['token']
    return Response("success test_api:" + token, status=status.HTTP_200_OK)

但是，我明白了（注意到 v2 不分组）。而且当我做测试时，也有错误。（代码 404 错误：未找到）

如何将这些分组到 drf_yasg 中的 API 并确保没有错误？注意如果url.py是这样的，没有错误，但它不分组

path('token_api1', token_api1, name='token_api1'),
path('token_api2', token_api2, name='token_api2'),

Answer 1

name 用于从您的 Django / Python 代码访问端点。所以我相信 Django 的新版本禁止重名。

您可以通过在 tags 下为端点提供相同的标签来对它们进行分组。像这样：

@swagger_auto_schema(tags=["my_custom_tag"], auto_schema=NoPagingAutoSchema, filter_inspectors=[DjangoFilterDescriptionInspector])
@action(detail=False, methods=['get'])
def action1(self, request):
    pass


@swagger_auto_schema(tags=["my_custom_tag"], method='delete', manual_parameters=[openapi.Parameter(
    name='delete_form_param', in_=openapi.IN_FORM,
    type=openapi.TYPE_INTEGER,
    description="this should not crash (form parameter on DELETE method)"
)])
@action(detail=True, methods=['delete'])
def action2(self, request, slug=None):
    pass

请注意，您还可以为每个函数提供多个标签，因此它们将显示在几个不同的类别（或组）中。

结果：

Answer 2

只需用这个 @swagger_auto_schema(tags=['tag_name']) 装饰您的视图 swagger_auto_schema 可以用 from drf_yasg.utils import swagger_auto_schema

导入

如何将 swagger API 端点（基于函数的视图）与 drf_yasg 分组 - Django

How to group swagger API endpoints (Function Based Views) with drf_yasg - Django

django

django-rest-framework

swagger

drf-yasg

redoc