API DOC 安装使用 笔记（win10/IDE-phpstorm）

---

1.安装nodejs：

访问https://nodejs.org/en/，下载，安装

---

 

2.安装apidoc

WIN+R打开运行cmd

执行：npm install apidoc -g

---

 

3.项目添加apidoc.json

在项目根目录，如test文件夹，新建文件命名为apidoc.json

内容如下：

{
  "name": "文档名称/项目名称",
  "version": "1.0.0",
  "description": "文档说明信息",
  "title": "页面标题（HTML的title）",
  "url" : "一串URL字符串，可以写站点的根目录，最后会和注释一起拼成API"
}

---

 

4.文件添加注释

内容如下：

/**
     * @api {get} index.php?i=  测试一
     * @apiGroup test
     * @apiVersion 0.0.1
     * @apiDescription 这是第一个测试
     * @apiParam {String} token 登录token
     * @apiParamExample 请求样例
     * /index.php?i=8888
     *  @apiSuccess {int} type 类型 0：上行 1：下行
     * @apiExample 请求成功数据
     * {
     *    "status": "1",
     *    "data": {
     *               "first": 1,
     *               "last": 3,
     *    },
     *    "msg": "操作成功"
     * }
     * @apiExample {json} 失败返回样例:
     *     {"code":"0","msg":"修改成功"}
     */

---

 

5.生成文档

 

打开cmd

输入：apidoc -i 已注释的代码所在目录 -o 想要文档生成在哪个目录

 

举例：

已注释的代码目录为C:\test\application\admin\controller

又，在test目录下建立src文件夹作为输出目录

apidoc -i C:\test\application\admin\controller -o src/

---

 

以上