提前安装好Web服务器
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
如果xz命令不存在则先安装xz:
https://sourceforge.net/projects/lzmautils/files/latest/download?source=typ_redirect
上传安装包到服务器，解压，安装
tar -zxvf xz-5.2.4.tar.gz cd xz-5.2.4 mkdir /usrl/local/xz ./configure --prefix=/usrl/local/xz #指定安装目录 make && make install #编译并安装
设置环境变量
vi /etc/profile //在 export PATH USER LOGNAME MAIL HOSTNAME HISTSIZE HISTCONTROL 一行的上面添加如下内容: export XZ_HOME=/usrl/local/xz export PATH=${XZ_HOME}/bin:$PATH source /etc/profile
再解压:
?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
npm install apidoc -g
3.创建测试文件，apidoc.json文件和test.php文件
{ "name": "****", "title": "****API", "description":"****API接口文档", "url" : "http://api.demo.com", "version": "0.1.0" }
/* @api {post} /shop/getList 通过商家id获取店铺列表
* @apiGroup Shop
*
* @apiParam (params) {int} id 商家id
* @apiParamExample 请求参数Demo:
* {
* "id": 2,
* }
*
* @apiSuccess {Array} article 返回相应id的文章信息
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* "tile": "文章标题2",
* "date": 1483941498230,
* "author": "classlfz",
* "content": "文章的详细内容"
* }
*
* @apiSampleRequest http://51.133.54.142
*/
4：生成对应的接口文档
apidoc -i input_your_file/ -o output_your_file/
其中input_your_file放置的是事先按照apidoc格式编写好的js文件，output_your_file则指定了生成的html的位置(nginx网站目录下)
最终效果展示:
原文：https://www.cnblogs.com/cx850116/p/10931455.html