如何使用django_rest_swagger 2.1.1显示API描述

时间:2017-05-26 06:11:22

标签: django django-rest-framework swagger-2.0 django-rest-swagger

对于0.3版本,DRF能够在Swagger设置中读取信息数据并在Swagger UI中进行渲染。

SWAGGER_SETTINGS = 
{  
......  
"info": {  
    'contact': 'xxxxx@github.com',   
    'description': 'This document intends to describe all Restful APIs.',  
    'title': 'GSLB API document',  
     },  
"USE_SESSION_AUTH": True  
}

但是对于版本2.1.1,似乎swagger_settings不支持信息字段?标题可以如下传递:

schema_view = get_swagger_view(title='My Restful API')

但似乎没有办法将描述传递给get_swagger_view,因此我无法在Swagger UI上显示描述。这个版本有解决方法吗?感谢。

1 个答案:

答案 0 :(得分:1)

对于当前版本的Django Rest Framework Swagger,添加docstring注释似乎有效(例如,它们在Swagger文档中显示为描述)。

class MyExport(mixins.ListModelMixin, viewsets.GenericViewSet): """ A really cool function"""

和#34;一个非常酷的功能"在swagger视图中显示为描述。