1. 创建项目
2. 获取api_key和api_token
1. 打开设置
2. 获取api_key和token
3. 生成文档
1. 先cd进入你的项目目录，命令行模式下输入：
wget https://www.showdoc.cc/script/showdoc_api.sh
下载完毕，编辑
vi showdoc_api.sh
脚本内容的前面有两个变量，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目录。
保存文件后。执行以下命令，脚本会自动递归扫描本目录和子目录的所有文本代码文件，并生成API文档。
chmod +x showdoc_api.sh
./showdoc_api.sh
3. 文档注释规范
想要生成文档，需要按照规范进行注释：
示例：
/**
* 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
*/
以上示例显示效果如下：
关键字
关键字
说明
@catalog
生成文档要放到哪个目录。如果只是二级目录，则直接写目录名字。如果是三级目录，而需要写二级目录/三级目录，即用/隔开。如”一层/二层/三层”
@title
表示生成的文档标题
@description
是文档内容中对接口的描述信息
@method
接口请求方式。一般是get或者post
@url
接口URL。不要在URL中使用&符号来传递参数。传递参数请写在参数表格中
@header
可选。header说明。一行注释对应着表格的一行。用空格或者tab符号来隔开每一列信息。
@param
参数表格说明。一行注释对应着表格的一行。用空格或者tab符号来隔开每一列信息。
@json_param
可选。当请求参数是json的时候，可增加此标签。请把json内容压缩在同一行内。
@return
返回内容。请把返回内容压缩在同一行内。如果是json，程序会自动进行格式化展示。 如果是非json内容，则原样展示。
@return_param
返回参数的表格说明。一行注释对应着表格的一行。用空格或者tab符号来隔开每一列信息。
@remark
备注信息
@number
可选。文档的序号。
)
和deepcopy())
