Linux环境下apidoc安装配置

一.安装apidoc所需环境(nodejs)

1. 查看系统是32位还是64位

uname -r

2. 到node官网下载node的包

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 -C /usr/local/src/

3. 进入文件所在目录，重命名

解压好的目录移动到指定位置:mv node-v8.1.2-linux-x64 /usr/local/src/nodejs

4. 建立软连接，变为全局环境变量。

ln -s /usr/bin/nodejs/bin/npm /usr/local/bin/

ln -s /usr/bin/nodejs/bin/node /usr/local/bin/

5. 测试安装是否成功。显示版本号则表示安装成功！

检测是否安装成功

二.apidoc

cd  /usr/local/src/nodejs/bin/目录下执行

npm install apidoc -g

安装apidoc

2.建立软连接，变为全局环境变量。

[root@local ~]# sudo ln -s /usr/local/src/nodejs/bin/apidoc /usr/local/bin/

apidoc 生成全局变量

全局软连接已经建立成功

3.apidoc已经变成全局变量了,开始apidoc项目中正常使用吧

使用apidoc生成文档

[root@local tp3]# apidoc -i Application/ -o mydoc1/

项目目录

apidoc.js配置文件

查看接口文档

参考图

安装参考