1

对于 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 版本,似乎不支持 info 字段swagger_settings?标题可以按如下方式传递:

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

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

4

1 回答 1

2

对于当前版本的 Django Rest Framework Swagger,添加文档字符串注释似乎可以工作(例如,它们在 Swagger 文档中显示为描述)。

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

并且“一个非常酷的功能”显示为招摇视图中的描述。

于 2018-05-21T18:40:44.810 回答