app后端开发一：swagger-ui教程-构建api接口文档工具
声明
之前写过关于app后端开发的一系列文章，那是我第一次做app后端开发，存在很多不足，本想好好修改一下，想想还是重新写吧，这样子也能让我博客文章看起来多一点嘛，万一以后找工作，别人一看我博客这么多内容，是不是很屌？
这次文章先从构建resetful风格的api文档工具开始。没有一个好的文档工具，在app前端人员开发过程中会导致开发效率极低，而且时不时的，他们就来找你跟他们断点一下。
我的文档经历
这里先不讨论我的数据传输是否合理，仅仅以这些数据作为一个演示。后面会有专门的章节进行app数据传输加密的讲解。
- 在我第一次开发app后端的时候，使用的word文档，就是我先将所有数据格式定义好，会返回什么样的数据写好。前端人员照这个来进行开发。贴一张图吧：
PS:存在的问题：①接口改动时，不易被识别。②维护困难，不便于查找。③前端开发不能进行测试。(如果还要写缺点，有5K+字可以写出来，就省略了哈) - 在我开发第二个APP的后端时，先自己写了一个简易的app接口管理系统，用来后端发布接口，以及前端人员查看。效果如图：
PS:优点：①如果有多个前端人员，可以保证大家看到的是同一份文档。②通过接口的版本标识，方便大家查看是否修改，优点等等省略。缺点：①不能够进行在线接口测试，需要借助poster插件。 - 现在给大家要推荐下我利用一天时间改造的swagger-ui的中文版了。本来英文就非常好了，只是为了了解一下这个东东，顺手给他改成中文版了，也做为自己第一个github的项目吧。还是先上效果图吧：
接口模块界面：
接口列表界面：
某个接口界面：
OK，贴图到此为止啦，如果还没有看够的同学，给你们一个连接，自己去试试：
swagger-ui中文版地址：http://helei112g.github.io/swagger-ui/
相信经过刚刚的体验，不需要我说它的强大与便利了吧？不仅仅可以通过它立即进行在线测试，还可以根据返回的json它自动构建成model。便于你做决策。好处我就不说了，反正自从用了它，我们的前端腰不酸，腿也不痛了。写起代码来也精神了。
哦，最重要的，下载地址：
https://github.com/helei112g/swagger-ui
如果觉得不错，麻烦给个start吧，给我的鼓励一下下，谢谢！
app后端开发系列文章目录
app后端开发一：swagger-ui教程-构建api接口文档工具相关推荐
- swagger php 生成api,blog/Swagger生成php restful API接口文档.md at master · lfq618/blog · GitHub...
Swagger生成php restful API接口文档 背景 我们的restful api项目采用yaf框架, 整体结构简单, 我们只需要用swagger扫描 application目录即可. 下面 ...
- Swagger 生成 PHP restful API 接口文档
需求和背景 需求: 为客户端同事写接口文档的各位后端同学,已经在各种场合回忆了使用自动化文档工具前手写文档的血泪史. 我的故事却又不同,因为首先来说,我在公司是 Android 组负责人,属于上述血泪 ...
- React 教程及其API接口文档
React 详细中文开发文档,可以阅读:http://reactjs.cn/react/docs/tutorial.html 英文原文:http://facebook.github.io/react/ ...
- 芋道 Spring Boot API 接口文档 Swagger 入门
点击上方"芋道源码",选择"设为星标" 做积极的人,而不是积极废人! 源码精品专栏 原创 | Java 2020 超神之路,很肝~ 中文详细注释的开源项目 RP ...
- Swagger 生成 PHP API 接口文档
Swagger 生成 PHP API 接口文档 标签(空格分隔): php 1.概况 有同学反馈写几十个接口文档需要两天的工作量, 随着多部门之间的协作越来越频繁, 维护成本越来越高, 文档的可维护性 ...
- Swagger:搭建Swagger API接口文档
文章目录 Swagger 1.1导语: 1.2 Swagger是什么?它能干什么? 1.3Swagger简介 1.4 Swaggerr特点: SpringBoot 集成Swagger 1. 导包 2. ...
- API接口文档利器：Swagger
文章目录 API接口文档利器:Swagger Swagger介绍 Swagger常用注解 Swagger测试 Swagger生成API文档的工作原理: API接口文档利器:Swagger Swagge ...
- Spring Boot API 接口文档 Swagger 入门
转载自 芋道 Spring Boot API 接口文档 Swagger 入门 摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/Swagger/ 「芋道源码」欢迎转 ...
- Laravel使用swagger PHP生成api接口文档
Laravel使用swagger PHP生成api接口文档 Swagger集接口文档和测试于一体,就类比将postman和showdoc的结合体 首先要先安装基于laravel5的swagger包 地 ...
最新文章
- 计算机里的文件弄不到桌面怎么办,笔记本电脑桌面上的文件夹不见了怎么办
- GTD资源列表[070826更新] - [GTD]
- mysql数据库连接_mysql数据库连接池配置教程
- aws s3 命令行_通过命令行界面使用AWS ElasticMapReduce
- 模块调用时对参数值的更改
- treeview 失去焦点时触发_33岁进央视，40岁主持《焦点访谈》的敬一丹，什么成就了她？...
- 【渝粤教育】国家开放大学2018年春季 7215-21T电气传动与调速系统 参考试题
- Cesium 高性能扩展之DrawCommand（二）：OSGB倾斜模型展示应用
- Ribbon界面开发总结
- Windows下常见的SQLite管理工具
- 1260.shift-2d-grid
- 8段数码管C语言,单片机控制4位8段数码管显示温度的程序谁会啊
- QQ等级查询API接口
- 转：我在淘宝这7年（四）
- 计算机笔记--【Redis高级】
- 破解网页文字无法复制的方法
- html当前窗口打开页面,JavaScript 在本窗口打开网页
- onCreate()方法
- 聊天机器人技术分析综述
- 蓝桥杯训练（python）Day2