接口文档开发apiDoc

---

一、apiDoc是什么？

是Nodejs中的一个模块，能够根据代码中的注释快速生成接口文档。

二、使用步骤

1.下载apiDoc模块

全局安装

npm install apidoc -g //或者npm i apidoc -g

npm下载是国外的资源，可以换成阿里源，这是全局安装

cnpm install apidoc -g 

2.在项目根目录创建apidoc.json文件

里边的内容是

{
  "name": "example",						//项目名
  "version": "0.1.0",						//版本号
  "description": "apiDoc basic example",	//项目描述
  "title": "Custom apiDoc browser title",	//标题
  "url" : "https://api.github.com/v1"		//路由地址
}

3. 接口注释

代码注释的格式

/**
 * @api {get} /user/:id Request User information			//请求方式 请求地址 描述
 * @apiName GetUser											//接口名字
 * @apiGroup User											//所属组名
 *
 * @apiParam {Number} id Users unique ID.					//参数类型 参数名字 参数描述
 *
 * @apiSuccess {String} firstname Firstname of the User.	//成功返回类型 名字 内容
 * @apiSuccess {String} lastname  Lastname of the User.		
 */

4. 生成接口文档

apidoc -i .接口注释目录 -o ./接口文档存放目录

生成接口文档基础的就是这四步，其它具体的apidoc接口文档的操作、要求可查看文档点这里。