swagger-ui教程-构建api接口文档工具

http://blog.csdn.net/hel12he/article/details/46547863

声明

之前写过关于app后端开发的一系列文章,那是我第一次做app后端开发,存在很多不足,本想好好修改一下,想想还是重新写吧,这样子也能让我博客文章看起来多一点嘛,万一以后找工作,别人一看我博客这么多内容,是不是很屌?  这次文章先从构建resetful风格的api文档工具开始。没有一个好的文档工具,在app前端人员开发过程中会导致开发效率极低,而且时不时的,他们就来找你跟他们断点一下。

我的文档经历

这里先不讨论我的数据传输是否合理,仅仅以这些数据作为一个演示。后面会有专门的章节进行app数据传输加密的讲解。

  1. 在我第一次开发app后端的时候,使用的word文档,就是我先将所有数据格式定义好,会返回什么样的数据写好。前端人员照这个来进行开发。贴一张图吧: 
PS:存在的问题:①接口改动时,不易被识别。②维护困难,不便于查找。③前端开发不能进行测试。(如果还要写缺点,有5K+字可以写出来,就省略了哈)
  1. 在我开发第二个APP的后端时,先自己写了一个简易的app接口管理系统,用来后端发布接口,以及前端人员查看。效果如图: 

PS:优点:①如果有多个前端人员,可以保证大家看到的是同一份文档。②通过接口的版本标识,方便大家查看是否修改,优点等等省略。缺点:①不能够进行在线接口测试,需要借助poster插件。

  1. 现在给大家要推荐下我利用一天时间改造的swagger-ui的中文版了。本来英文就非常好了,只是为了了解一下这个东东,顺手给他改成中文版了,也做为自己第一个github的项目吧。还是先上效果图吧:  接口模块界面: 

接口列表界面: 

某个接口界面: 

OK,贴图到此为止啦,如果还没有看够的同学,给你们一个连接,自己去试试:  swagger-ui中文版地址:http://helei112g.github.io/swagger-ui/

相信经过刚刚的体验,不需要我说它的强大与便利了吧?不仅仅可以通过它立即进行在线测试,还可以根据返回的json它自动构建成model。便于你做决策。好处我就不说了,反正自从用了它,我们的前端腰不酸,腿也不痛了。写起代码来也精神了。

哦,最重要的,下载地址:  https://github.com/helei112g/swagger-ui 本文转载自:http://blog.csdn.net/hel12he/article/details/46547863

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏云计算D1net

让云API远离黑客攻击

没有合适的安全措施,云API就会成为黑客的一扇门。那么如何确保云API的安全呢? 开发者可以使用云应用编程接口编码,而这个接口具备一项云提供商的服务。但是同时对...

41960
来自专栏Python小白进阶之旅

学会了爬虫,然后我一不小心就统治了整个Python吧

23580
来自专栏Python爬虫实战

Python爬虫:十几行代码下载王者荣耀所有皮肤

之前接触过爬虫还是几年前爬取豆瓣电台的歌曲,那时候用的C++,json解析还要用第三方库,总之很麻烦。最近接触到了python,深深的感觉这门语言真好。

43090
来自专栏java一日一条

Linux 新手容易犯的 7 个错误

改变操作系统对于任何人来说都是迈出的一大步,特别是当许多用户不确定操作系统究竟如何的时候,尤其如此。

15410

比较服务网格体系结构

如果你正在围绕微服务构建您的软件和团队,那么你应该正在寻找更快迭代和灵活扩展的方法。服务网格可以帮助你在保持(或增强)可见性和控制的同时实现这一点。在这篇博客中...

41460
来自专栏知识分享

1-物联网开发标配方案(预期方案使用说明和演示)

实现的功能:WIFI模块和手机APP连接MQTT服务器,单片机采集的温湿度数据通过WIFI远程发送给APP显示,APP远程控制单片机的LED亮灭

22130
来自专栏Android群英传

推送,从入门到放弃

22020
来自专栏云计算D1net

混合云文件服务如何解决企业的文件问题

文件是现代组织的主要资产。混合云文件服务通过结合云计算和内部部署的文件系统的优势,将在全球范围内越来越多地用于管理和共享文件。

17400
来自专栏杨建荣的学习笔记

数据库无响应问题的紧急处理和分析 (r10笔记第42天)

黄金周里处理了一起紧急的问题,在外面幸亏有同事帮忙协助,等我赶回家去,赶紧继续处理。 首先问题是在晚饭时间左右开始发生,但是过了没多久又恢复了,所以这个问题暂时...

340120
来自专栏Spark学习技巧

Redis热点Key发现及常见解决方案

在日常工作生活中一些突发的的事件,例如:双十一期间某些热门商品的降价促销,当这其中的某一件商品被数万次点击浏览或者购买时,会形成一个较大的需求量,这种情况下就会...

25330

扫码关注云+社区

领取腾讯云代金券