node 生成api文档 使用apidoc

先给大家看一下使用apidoc生成文档之后的视图，如果是所需的样子，可以继续往下看，

 

开始操作

1. 需要全局安装apidoc

npm i apidoc -g 

 

2. 生成配置文件

　　两种方法（用哪个都可以）

• 第一种  　自己在根目录创建一个apidoc.json

{
    "name": "租电后台系统接口",
    "version": "0.1.0",
    "description": "用户服务API文档",
    "title": "Custom apiDoc browser title",
    "url": "http://localhost:8888"
}

• 第二种 　在package.json写入　

"apidoc": {  
    "title": "接口文档", //Api-Doc的网页Title
    "url": "http://localhost:3000" //Api测试需要这个地址，地址必须正确
  }

 

3. 执行命令生成api文件　　

生成api文档之前需要写一些接口注释，大家可以直接复制过去用，所生成的文档就是下面的测试接口

/**
 * @api {get} /user/:id 请求用户数据接口
 * @apiName GetUser
 * @apiGroup 用户
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 *
 * @apiSuccessExample Success-Response:
 *     HTTP/1.1 200 OK
 *     {
 *       "firstname": "John",
 *       "lastname": "Doe"
 *     }
 *
 * @apiError UserNotFound The id of the User was not found.
 *
 * @apiErrorExample Error-Response:
 *     HTTP/1.1 404 Not Found
 *     {
 *       "error": "UserNotFound"
 *     }
 */

　　

　　执行如下命令会在public下自动生成apidoc文件夹

apidoc -i routes/ -o public/apidoc/

　　

　　生成成功后，我们就可以测试运行api文档了，访问路径：http://localhost:3000/apidoc/index.html