做项目的时候，写完一个接口，还要去再写一遍api文档，接口数据发生变化还要去手动同步文档参数，挺浪费时间的。所有我选择用ShowDoc自动生成api接口文档。

1. 首先去 https://www.showdoc.cc/ 注册一个账户，新建一个项目

2. 建立新项目后，选择该项目，打开，进入项目界面
   
   
3. 然后点击项目，下拉选择项目设置
   
4. 自动化生成API文档，首先需要下载Git ，推荐下载地址： https://npm.taobao.org/mirrors/git-for-windows/v2.17.0.windows.1/Git-2.17.0-64-bit.exe

5. 基础环境。安装好了后，还需要下载showdoc官方脚本：https://www.showdoc.cc/script/showdoc_api.sh

下载后，将showdoc_api.sh放在你的项目目录下。右击，选择编辑。

6. 脚本内容的前面有两个变量，api_key 和 api_token ，这个需要用户自行填写。关于这两个变量的取值，请登录showdoc，进入某个项目的设置，点击开放API，便可以看到说明。showdoc_api.sh生成的文档会放进你填写的这个项目里。除了api_key 和 api_token ，还有一个url变量。如果是使用www.showdoc.cc ，则不需要修改。如果是使用开源版showdoc，则需要将地址改为http://xx.com/server/index.php?s=/api/open/fromComments ，其中，别忘记了url里含server目录。

7. 填写完毕，保存。然后直接双击运行，脚本会自动递归扫描本目录和子目录的所有文本代码文件，并生成API文档。
8. 为了方便测试，官方还提供了一个例子。请下载：
   https://www.showdoc.cc/script/api_demo.test

语法说明

一个标准语法例子：

/**
* showdoc
* @catalog 测试文档/用户相关
* @title 用户登录
* @description 用户登录的接口
* @method get
* @url https://www.showdoc.cc/home/user/login
* @header token 可选 string 设备token 
* @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
*/

详细可以查看官方文档