使用showdoc快速生成在线文档

1、首先进入ShowDoc官网进行账号注册(https://www.showdoc.cc/)

 

2、注册成功即跳转至showdoc主页，如下图：

 

3、选择新建项目

 

4、填写信息后点击提交，如下图：

 

5、项目新建成功

 

 

6、进行项目设置

7、选择开放API，找到如下图： 

 

 

8、浏览API文档下载showdoc自动生成API的官方脚本showdoc_api.sh文件，如下图：

 

 

9、下载成功，可选择保存在你自己定义的路径中

 

10、编辑showdoc_api.sh文件，修改脚本中的key、token，修改成showdoc中项目对应的key和token，如下图：

 

11、按照showdoc规定的注释格式给需要生成文档的API接口加上注释，代码如下：

 /**
    * 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
    */

效果图： 

 

12、将showdoc_api.sh文件复制到项目中，右键项目，选择在文件资源管理器中打开文件夹，双击执行showdoc_api.sh文件，如下如：

 

13、执行成功.....

 

14、去showdoc中查看刚生成的在线文档，效果图如下：

 

15、若想其他人可访问你的在线文档，可在showdoc中添加团队，即可访问文档！