>本文案例收录在 https://github.com/chengxy-nds/Springboot-Notebook

大家好，我是小富~

前几天粉丝群有小伙伴问，有啥好用的API文档工具推荐，无意间发现了一款工具，这里马不停蹄的来给大家分享一下。

`ShowDoc`一个非常适合团队的在线API文档工具，也支持用`docker`自建文档服务，不过为了方便演示，我直接用了平台在线服务。官网地址：

```shell
https://www.showdoc.com.cn/item/index
```

可以使用`markdown`语法来写API文档、数据字典文档、技术文档、在线`excel`文档。但像我这种资深的懒人程序员，其实更看重的是`showdoc`的自动化生成文档的特性，它可以从代码注释中自动生成API文档，或者搭配`RunApi`客户端（类似postman的api调试工具）一边调试接口、一边自动生成文档。

下边从头演示下，来瞅瞅这玩意好用在哪？

![主页](https://img-blog.csdnimg.cn/20210712162242241.png)

### 初识 ShowDoc

`ShowDoc`新建项目可选常规的API文档、在线表格、或者单页文档（不支持目录分层），允许对项目文档设置访问密码，自定义域名，这里并不是真正意义上的“域名”，只是在文档服务域名后加了一级目录，例如：

```
www.showdoc.com.cn/程序员内点事
```

![](https://img-blog.csdnimg.cn/20210712162502215.png?)

可以复制现有的项目，或直接导入`Postman`、`swagger`的API接口配置Json文件。提供的开放API是自动化生成文档的关键，先记住有`api_key`、`api_token`这两个属性，后边详细讲。

![](https://img-blog.csdnimg.cn/20210712170125250.png)

进入项目后点击右上角 **+** 编辑文档，`ShowDoc`预置了几种文档模板，也可以把自定义的文档存为模板；支持在线`Mock`服务，提前定义好接口的数据格式，先提供在线临时接口，这样就可以和前端同步开发，后边无缝切换；还有个简单的API在线测试功能。

![](https://img-blog.csdnimg.cn/20210712172948200.png)

在线表格样式很简洁

![](https://img-blog.csdnimg.cn/img_convert/3c98f596ed8a1d7d6f8effa78f47c5e2.png)

导出文档有`word`、`Markdown`两种格式。

![](https://img-blog.csdnimg.cn/20210712183915285.png)

支持版本控制，能看到每次修改的记录，回滚任意一个版本的修改。

![](https://img-blog.csdnimg.cn/20210712184756888.png)

在向别人分享在线文档时，如果不想将整个API目录都暴漏，可以选择进行单页面分享。
![](https://img-blog.csdnimg.cn/img_convert/c1788e5b88553d0405cb963fa64d9ad1.png)

看到这感觉`showdoc`很普通啊，好像没什么特别的地方，上边的这些文档都是需要我们手动书写的，比较繁琐不推荐这么搞，接下来咱们看看如何自动化生成文档。

### 自动生成文档

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

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

**Runapi工具**

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

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

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

![](https://img-blog.csdnimg.cn/img_convert/6c8ad79fef15237797c0593beaa60df7.png)

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

![](https://img-blog.csdnimg.cn/img_convert/ff6edbdb77633f3828ddff62980bef1d.png)

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

![](https://img-blog.csdnimg.cn/img_convert/a7f23100461f98ec236bbc94b15ad66e.png)

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

![](https://img-blog.csdnimg.cn/img_convert/9cae596afe75f5bfb90566f6b348f030.png)

### 代码注释

把接口的信息写在注释里也可以自动生成文档到`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环境演示。

首先本地要有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如果没搭建自己的文档服务不用改。

![](https://img-blog.csdnimg.cn/img_convert/2d26dce720db6697bc724225f67a9740.png)

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

![](https://img-blog.csdnimg.cn/img_convert/4902542e07820b95ae72fb1bec6cb61e.png)

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

![](https://img-blog.csdnimg.cn/img_convert/5220d210eff6d88eb839ffdc3b137e11.png)

### 生成数据字典

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

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

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

![](https://img-blog.csdnimg.cn/img_convert/b5ca734a0095adf25b5571bfaba13678.png)
如下配置的变量名和解释
![](https://img-blog.csdnimg.cn/img_convert/27abc9b89902ea32b677a8cc201fb921.png)

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

![](https://img-blog.csdnimg.cn/img_convert/59a0194b7376ab3853455163c949f99d.png)

### 开放API

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

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

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

![](https://img-blog.csdnimg.cn/img_convert/a346b5020e924058970b32764fbd8d61.png)

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

```
{
  "api_key": "8e52cbad736aa9832b92acc4b34a830e961861279",
  "api_token": "9dcd8333afa7cde63bf84f8f0db5d2b2116079256",
  "page_title": "xiaofu",
  "page_content": "nihao"
}
```
![](https://img-blog.csdnimg.cn/20210715164840833.png)
看到在`showdoc`对应的项目里已经创建了名字为`xiaofu`的文档。
![](https://img-blog.csdnimg.cn/20210715164538196.png)

### 说两句

前边说过`showdoc`现有的功能`postman`基本都支持，但`postman`功能过于繁杂不够简洁，加上网络条件等诸多限制，协同办公的效率并不高，而`Runapi`配合`showdoc`在某些场景下能够很大程度上提升我们开发交付的效率，所以能自动生成的绝对不手写！

再怎么BB吹嘘都是苍白的，好不好用，适不适合自己，动手搞一下一目了然

我是小富，下期见~

整理了几百本各类技术电子书，有需要的同学自取。技术群快满了，想进的同学可以加我好友，和大佬们一起吹吹技术。

[**电子书地址**](https://github.com/chengxy-nds/Springboot-Notebook)

ITPub博客

干掉 Postman？测试接口直接生成API文档，这个工具贼好用

最新文章