apidoc 的安装
1.先去官网下载已编译好的安装包
以Centos7.4 64位为例, 下载地址: https://nodejs.org/dist/v8.1.2/node-v8.1.2-linux-x64.tar.xz
wget https://nodejs.org/dist/v8.1.2/node-v8.1.2-linux-x64.tar.xz
执行解xz命令:
xz -d node-v8.1.2-linux-x64.tar.xz
再解压:
tar -xvf node-v8.1.2-linux-x64.tar
解压好的目录移动到指定位置:
mv node-v8.1.2-linux-x64 /usr/local/nodejs
做命令连接:
ln -s /usr/local/nodejs/bin/node /usr/local/bin
ln -s /usr/local/nodejs/bin/npm /usr/local/bin
测试版本号:
node -v
完成
2：安装apidoc
/usr/local/nodejs/bin/npm install apidoc -g
安装成功一般提示：
安装失败可能是由于权限不足，重新加上sudo进行安装：
sudo /usr/local/nodejs/bin/npm install apidoc -g
提示“/usr/bin/env: node: No such file or directory” ，需执行以下命令解决
ln -s /usr/local/nodejs/bin/node /usr/bin/node
3.创建测试文件，apidoc.json文件和test.php文件
apidoc.json:
{
"name": "****",
"title": "****API",
"description":"****API接口文档",
"url" : "http://api.demo.com",
"version": "0.1.0"
}
test.php文件
/**
*
* @api {get} /user/{id}
* @apiDescription 获取用户信息接口描述
* @apiGroup User
* @apiName getUserInfo
* @apiParam {Number} id 用户ID
* @apiVersion 0.1.0
*
*
* @apiExample {curl} 访问示例：
* curl -i http://api.demo.com/user/4711
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/
function GetUser($id){}
4：生成对应的接口文档
采用下面的命令：
/usr/local/nodejs/bin/apidoc -i input_your_file/ -o output_your_file/
其中input_your_file放置的是事先按照apidoc格式编写好的js文件，output_your_file则指定了生成的html的位置。
例子如下：
注意：出现如下错误提示error: No files found，可能是某些文件导致出现的问题，需要自行确认查找那些文件影响了文档的生成
