干掉 Postman？测试接口直接生成API文档，这个工具贼好用_postman 精简版(1)

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上软件测试知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化的资料的朋友，可以戳这里获取

showdoc有三种自动生成API文档的方式：

• 使用Runapi工具自动生成（推荐）
• 使用程序代码注释自动生成
• 自动生成数据字典
• 自己写程序调用接口来生成

Runapi工具

Runapi是一个以接口为核心的开发测试工具（可以看做是Postman的精简版）。目前客户端支持win、mac、linux平台和在线版 ，包含接口测试、自动流程测试、Mock数据、项目协作等功能。

单纯的Runapi和Postman相比优势并不大，而与showdoc配合使用效率比较显著，用runapi测试接口的同时它将自动生成API文档到showdoc，也可共用showdoc的团队管理机制实现多人协作。

Runapi客户端可以创建带调试的API接口文档、或者Markdown格式的文档。

比如我们新建个项目“程序员内点事”，分别建三个接口“点在”、“在看”、“关注”，紧接着快速生成参数和响应结果数据并保存。

点击右上角的文档链接设置访问密码，不填默认是公开的，复制文档链接在浏览器中打开，看到API接口文档已经生成。runapi还有全局参数、环境隔离。其实Postman也支持这样的功能，不过毕竟不是国内产品，网络访问等方面很受限制。

还有一个比较好的地方，Runapi支持接口执行前后的脚本，比如响应数据的断言测试，弹框显示都挺好用的。

代码注释

把接口的信息写在注释里也可以自动生成文档到showdoc，但这种我并不太喜欢，主要是侵入性比较强，让代码的阅读性变的比较差，一坨坨看着很不爽。

	/**
	* showdoc
	* @catalog 测试文档/用户相关
	* @title 用户注册
	* @description 用户注册的接口
	* @method post
	* @url https://www.showdoc.com.cn/home/user/login
	* @param username 必选 string 用户名  
	* @param password 必选 string 密码  
	* @param name 可选 string 用户昵称  
	* @return {"error_code":0,"data":{"uid":"1","username":"12154545","name":"吴系挂","groupid":2,"reg_time":"1436864169","last_login_time":"0"}}
	* @return_param groupid int 用户组id
	* @return_param name string 用户昵称
	* @remark 这里是备注信息
	* @number 99
	*/
	public Object register(){

这种方式的实现也比较简单，还记得前边的提到的api_key、api_token这两个属性嘛，现在派上用场了，下边我用windows环境演示。

点我全套软件测试(自动化测试)学习资料抱走【备注csdn000】学习资料抱走【备注csdn000】")

首先本地要有git环境：

https://npm.taobao.org/mirrors/git-for-windows/v2.17.0.windows.1/Git-2.17.0-64-bit.exe

再下载showdoc官方提供的脚本

https://www.showdoc.cc/script/showdoc_api.sh

修改showdoc_api.sh，替换我们api_key和api_token变量值，URL如果没搭建自己的文档服务不用改。

将showdoc_api.sh放在你的项目目录下，直接双击运行，脚本会自动递归扫描本目录和子目录的所有文本代码文件，并生成API文档。

showdoc_api.sh生成的文档会放进你填写api_token的这个项目里。

生成数据字典

如果我们想直接从数据库字典表生成数据字典文档，showdoc也是支持的，先下载官方提供的脚本

wget https://www.showdoc.cc/script/showdoc_db.sh

修改脚本里的配置，数据库、api_key、api_token等信息，直接执行后数据库表结构信息同步到showdoc。

如下配置的变量名和解释

效果就是如下图这样，生成了数据表字典文档，在一些特定场景下还是很方便的。

开放API

showdoc开放了文档编辑的API，我们可以在代码中调用API创建、编辑文档。这样使用的场景就比较灵活了。

https://www.showdoc.cc/server/api/item/updateByApi

API参数如下，文档内容，可传递markdown格式的文本或者html源码都可以。

测试一下接口组装必要的参数，用简易在线API调试工具发送

点我全套软件测试(自动化测试)学习资料抱走【备注csdn000】学习资料抱走【备注csdn000】")

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上软件测试知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化的资料的朋友，可以戳这里获取

程，涵盖了95%以上软件测试知识点，真正体系化！**

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化的资料的朋友，可以戳这里获取