drf-yasg外面如何显示api描述?

时间:2019-10-16 10:27:55

标签: django django-rest-framework drf-yasg

我要在其中进行描述:
picture 1
  但是我在里面:
picture 2
这是我的代码:

@swagger_auto_schema(method='GET', manual_parameters=[project_param])
@api_view(['GET'])
def get_project_info(request):
    """
    获取项目信息
    """

版本信息:
Django == 2.2.1
drf-yasg == 1.16.1

2 个答案:

答案 0 :(得分:2)

如果以下格式说明中使用的文档字符串可在其中找到:

class ProductOperation(ModelViewSet):
   """
   Outside

   Inside

   """

enter image description here

答案 1 :(得分:0)

您可以使用swagger_auto_schema装饰器来显示ID,摘要和说明。

from drf_yasg.utils import swagger_auto_schema

class ProductOperation(ModelViewSet):
    @swagger_auto_schema(
        operation_id='Display end of opblock',
        operation_summary="Display outside",
        operation_description='Display inside',
    )
    def action_one(self, request):
        dosomething()

looks like this