快速根据注释生成接口文档网页工具——Apidoc的使用教程

环境：

操作系统 CentOS Linux release 7.6.1810 (Core) 64位

服务器环境 “腾讯云”服务器

1，安装Node.js的npm工具环境：

2，npm环境搭好后，控制台运行命令：

npm install apidoc -g

等待安装完成

快速根据注释生成接口文档网页工具——Apidoc的使用教程

2，新建接口程序文件test.java 中添加apidoc文档注释

创建新目录

mkdir -p /data/apidoc/
cd /data/apidoc/

/data/apidoc目录新建文件test.java，内容如下：

/**
          * @apiDefine userApiStr 用户接口文档 
          */
        
        /**
         * @api {POST} /login 用户登录
         * @apiName api测试
         * @apiGroup userApiStr
         * @apiVersion 1.0.0
         * @apiDescription 用于用户登录
         * @apiParam {String} userName 用户名
         * @apiParam {String} password 密码
         * @apiParamExample {json} 请求样例：
         *                ?userName=张三&password=11223344
         * @apiSuccess (200) {String} msg 信息
         * @apiSuccess (200) {String} code 0 代表无错误 1代表有错误
         * @apiSuccess (200) {String} user 用户信息
         * @apiSuccess (200) {String} userId 用户id
         * @apiSuccessExample {json} 返回样例:
         *                {"code":"0","msg":"登录成功","userId":"fe6386d550bd434b8cd994b58c3f8075"}
         */

3，生成apidoc文档，在当前注释文件目录下输入命令

apidoc -i /data/apidoc -o /data/apidoc
# apidoc    -i    注释文件所在目录路径     生成的apidoc文档所在目录路径

快速根据注释生成接口文档网页工具——Apidoc的使用教程

完成后显示了生成的apidoc文件目录：

快速根据注释生成接口文档网页工具——Apidoc的使用教程

打开 ”index.html“ 查看生成的接口文档

快速根据注释生成接口文档网页工具——Apidoc的使用教程

到这里，apidoc就成功跑起来了

快速根据注释生成接口文档网页工具——Apidoc的使用教程

相关推荐