windows apidoc 安装与配置

1，安装 node,官网下载

node下载

2，安装 apidoc,打开 cmd，输入如下内容

npm install apidoc -g

3，随便找个文件夹，创建好所需文件如下图：

1）apidoc.json 文件内容如下：

{
  "name": "文档名称",
  "version": "1.0.0",
  "description": "文档说明",
  "title": "文档标题",
  "url" : "http://local.test.com",
  "sampleUrl" : "http://local.test.com"
}

2）api.php 文件内容,建立自己所用语言的后缀文件,并用注释编写 api 接口文档

/**
 * @api {POST} login/register 注册
 * @apiGroup Login
 * @apiDescription 注册
 * @apiParam {String} timeStamp 时间戳.
 * @apiParam {String} sign 签名.
 * @apiParam {String} params[mobile] 手机
 * @apiParam {String} params[code] 验证码
 * @apiParam {String} params[password] 密码
 * @apiVersion 1.0.0
 * @apiSuccess (200) {String} code 0,成功1,失败-2,验证码失效
 * @apiSuccess (200) {String} msg 返回成功或错误信息
 * @apiSuccess (200) {String} time 时间戳
 * @apiSuccess (200) {Object} data 返回数据
 * @apiSuccess (200) {String} data.token 登录token
 * @apiSuccessExample {json} 返回样例:
 *                {"code":"0","msg":"\u6210\u529f","time":"1516074608","data":{"token":"6767"}}
 */

4，在 myapp 同级目录打开 cmd ,执行如下内容：

apidoc -i myapp/ -o apidoc/

5,打开 apidoc/index.html 文件，查看效果：