这是我参与8月更文挑战的第19天,活动详情查看:8月更文挑战
WangScaler: 一个用心创作的作者。
声明:才疏学浅,如有错误,恳请指正。
Swagger无论是在java开发还是在python开发中都会使用的接口文档,它大大的减轻了后端程序员的工作量,大大减少了前后端扯皮的次数。让你我更清静,哈哈哈哈哈。
在tornado中的swagger名字是Swagger_tornado,它不像在java中能自动生成,需要我们自己手写,但是一边撸代码一边写文档,也总比专门另写开发文档强。没办法tornado框架虽然很强,但用户量无法和django、Flask相比,简直就是大巫见小巫差太多了,也就导致tornado的轮子就比较少。
swagger文档标签、
swagger文档的标签默认是展开的,如下图中第二种User展开的状态。但是随着我们的开发接口越来越多,前端看的时候就会疯了,找一个接口就得疯狂滑动鼠标。所以这时候就需要将默认的展开的状态变成关闭。 那么我们怎么能让它变成第一种Data的状态呢?首先我的第一种反应就是代码里面能不能配置。
我先去翻阅了官方文档,发现没有。然后看了源码以及网上前辈们的经验,可能真的没有。如果你知道,务必告诉我,那么到底怎么解决这个问题呢?
1、修改访问地址栏
在访问地址的后面加上?docExpansion=none
,比如我们原来的url是www.scalerwang.com/api/doc
,那么现在的地址就是www.scalerwang.com/api/doc?docExpansion=none
轻松解决。不过需要用户自己去拼接,虽然可行,但不是最佳方案,可以通过更改源代码永久修改。
2、修改源代码
我们python的依赖都是通过pip安装的,所以找到python3的虚拟环境包的位置。
如果是默认的python3环境,不是虚拟环境的话,修改的文件在
/usr/local/python3/lib/python3.7/site-packages/tornado_swagger/swagger_ui/ui.html
打开该文件,在文件中加入
docExpansion=none
就这么简单就可以实现了。
当然docExpansion还有其他的参数。
其他参数
- docExpansion=none为不展开。
- docExpansion=list为展开。
- docExpansion=full为全部展开,包括接口的详细信息。
写在最后
如果你知道tornao其他好用的工具,可以在评论区里推荐给我, 赠人玫瑰手有余香。
来都来了,点个赞再走呗!
关注WangScaler,祝你升职、加薪、不提桶!