linux搭建apidoc

一、下载/安装nodejs

由于apidoc是基于nodejs平台,所以需要先安装nodeJS,本人选择安装版本为v8.11.3
输入https://nodejs.org进入nodejs官网,然后根据安装环境情况,选择对应包下载,下载完成后上传至linux服务器

也可以通过输入命令wget https://nodejs.org/dist/v8.11.3/node-v8.11.3-linux-x64.tar.xz 方式直接在linux中下载

然后执行命令​xz -d node-v8.11.3-linux-x64.tar.xz进行解压

解压后生成tar包,然后再次解压tar
tar -xvf node-v8.11.3-linux-x64.tar

将解压完成后的文件移动至/usr/local/nodejs
执行命令mv node-v8.11.3-linux-x64 /usr/local/nodejs

制作linux软连接
ln -s /usr/local/nodejs/bin/node /usr/local/bin
​ln -s /usr/local/nodejs/bin/npm /usr/local/bin
查看版本号
node -v

二、安装apidoc

执行命令npm install apidoc -g

在/usr/local中创建apidoc文件夹,用于存放api
mkdir apidoc
在apidoc下创建目录src用于存放源文件,创建目录doc用于存放编译后的文件
mkdir src / mkdir doc

三、测试

添加文件apidoc.json/header.md/footer.md/api.js
各个文件内容如下:
apidoc.json

header.md

footer.md

api.js

然后执行/usr/local/nodejs/bin/apidoc -i /usr/local/apidoc/src -o /usr/local/apidoc/doc

另可制作快速启动文件run.sh,方便编译。

修改run.sh权限chmod u+x *.sh

然后通过./run.sh完成编译.

最后配置nignx进行api的访问