首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何使用django_rest_swagger 2.1.1显示接口描述

如何使用django_rest_swagger 2.1.1显示接口描述
EN

Stack Overflow用户
提问于 2017-05-26 14:11:22
回答 1查看 618关注 0票数 1

对于0.3版本,DRF能够读取Swagger设置中的信息数据,并在Swagger UI中呈现它。

代码语言:javascript
复制
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中不支持info字段?标题可以按如下方式传递:

代码语言:javascript
复制
schema_view = get_swagger_view(title='My Restful API')

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

EN

回答 1

Stack Overflow用户

发布于 2018-05-22 02:40:45

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

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

“一个非常酷的功能”显示为swagger视图中的描述。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/44194773

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档