drf-yasg如何在外部显示api描述？

Question

我要把描述写进去：

但我的就在那里面：

这是我的代码：

@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

Answer 1

如果以下格式描述中使用的Docstring将在以下位置提供：

class ProductOperation(ModelViewSet):
   """
   Outside

   Inside

   """

​

​

Answer 2

您可以使用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