java开发，根据代码自动生成api接口文档工具，支持RESTful风格

「官方给的一个示例：」

❝

此示例文档包含 apidoc 的所有可能的配置选项。

❞

git clone  && cd apidocnpm install --prod./bin/apidoc -i example -o /tmp/doc$BROWSER /tmp/docopen index.html

「看起来不容易看懂，那么我们来简化下：」

第一步,安装环境

npm install apidoc -g

第二步, 新建一个项目

「目录结构如下：」

「文件内容如下：」

test.js：打算放注释文档的文件，不用纠结这些注释含义

/** * @api {Get} /user/get getUserInfo * @apiGroup User * * @apiParam {String} name 文章名 * @apiParamExample {json} Request-Example * { *  "userName": "Eve" * } * * @apiSuccessExample  {json} Response-Example * { *   "userName": "Eve", *   "createTime": "1568901681" *   "updateTime": "1568901681" * } */function getUserInfo(username) {  // 假如这个函数是根据用户名返回用户信息的}/** * @api {Get} /stu/get getUserInfo * @apiGroup Stu * * @apiParam {String} name 文章名 * @apiParamExample {json} Request-Example * { *  "userName": "Eve" * } * * @apiSuccessExample  {json} Response-Example * { *   "userName": "Eve", *   "createTime": "1568901681" *   "updateTime": "1568901681" * } */

apidoc.json:文档配置文件。

{  "name": "apidoc-demo",  "description": "You write something here to describe your project",  "title": "The title of this doc"}

第三步, 执行命令。

❝

-i是指注释文件存放的地方, -o是指文档输出的位置

❞

apidoc -i src/ -o apidoc/

第四步，打开index.html。