摘要：
1、 安装1.安装node.js。下载链接：https://nodejs.org/zh-cn/2.安装apiDoc。命令行：npminstallapidoc-g 2.在项目Json文件中配置apidoc（我的配置在接口文件夹中），该文件描述了项目提供的外部接口的配置文件信息，例如名称、版本、描述、打开文档时浏览器显示的标题以及接口的默认访问地址。｛“name”：“ServiceEbikeAPI”，“ver
一、安装
1.安装node.js,下载链接：https://nodejs.org/zh-cn/
2.安装apiDoc，命令行：npm install apidoc -g
二、配置
在项目中配置apidoc.json文件（我的配置在接口文件夹下），该文件描述了项目对外提供接口的概要信息如名称、版本、描述、文档打开时浏览器显示标题和接口缺省访问地址。
{
"name": "ServiceEbikeAPIs",
"version": "3.1.0",
"description": "项目接口文档",
"title": "接口测试文档",
"url" : "http://xxxx.com/api"
}
使用样例：class Home {
/**
* 定义一个变量 用于apiGroup 因为不支持直接输入中文
* @apiDefine test 测试
*/
/**
* @api {post} /Index/getVip 获取vip列表 页面加载时自动获取
* @apiName GetUser
* @apiGroup test
*
* @apiParam {string} req1 请求值
*
* @apiSuccess {String} res1 返回值1
* @apiSuccessExample Success-Response:
* {
* res1:"test"
* }
*/
public function test(){
}
}
样例2：
/**
* @api {post} json/friendCircleList 朋友圈动态列表
* @apiSampleRequest json/friendCircleList
*
* @apiGroup 资讯接口/朋友圈动态接口
*
* @apiParam {int32} page 页数
* @apiParam {int32} pageSize 每页条数
* @apiParam {int32} type 动态发送者类型（1商家 2用户 可选）
* @apiParam {int32} type_id 动态发送者ID（商家或者用户ID，与type对应，可选）
* @apiParam {string} orderField 排序字段
* @apiParam {number} order_sort 排序升降（-1代表降序 1代表升序）
*
* @apiSuccess {Sting[]} data 数据
* @apiSuccess {String} data.code 返回数据结果码
* @apiSuccess {String} data.message 返回数据信息
*
* @apiSuccessExample Success-Response:
* "code": 0,
* "message": "succ",
* "data":[{
* "_id": {
* "$oid": "5dc618f1ed37514960002395"
* },
* "address": "江苏省苏州市",
* "content": "朋友圈动态内容",
* "id": "5dc618f1ed37514960002395",
* "zan_num": 0,
* "evaluate_num": 0,
* "create_time": "2019-10-28 12:42:44",
* "pics": [
* "http://bbt3.ff.5kb.pw/uploads/20191122/2de13ebac0e6e66bdcd11eb3c28d0d25.jpg"
* "http://bbt3.ff.5kb.pw/uploads/20191122/5b6158382ba17ed8a5a72fab3ca4f984.jpg"
* ],
* "type": 2,
* "type_id": 1,
* "is_del": 0,
* "author_info": {
* head_photo: ""
* nick_name: "散场的拥抱^_^"
* user_id: 1
* }
* }....
* ]
*/
参数具体说明参考：http://apidocjs.com
三、生成文档
cd到项目目录执行(我的是tp项目，文档路径可以自己定义)，例子如下：
apidoc -i application/api/controller -o public/docs
备住：其中"application/api/controller"为需要生成接口的项目目录，就是根目录下application/api文件夹下面的controller控制器，
"public/docs"为接口生成目录，也就是项目跟目录下的public/docs目录下
最后会在"public/docs"下面生成接口目录，点击index.html就可以查看接口文档
参考链接：https://www.jianshu.com/p/d324810d694d;https://www.jianshu.com/p/34eac66b47e3(感谢分享)