apiDoc部署搭建

apiDoc介绍:

目前，越来越多的项目进行前后端分离，那么就有需要比较规范的来管理API文档。而apiDoc这个API文档管理器，可以根据你项目代码的注释来进行自动生成API文档。同时支持C#、Java、JavaScript、PHP、Python等语言。

环境需要node,js

安装部署:

1.先把node-v8.7.0-linux-x64.tar.xz传到服务器上，或者直接yum

[root@backup ~]# xz -d node-v8.7.0-linux-x64.tar.xz 
[root@backup ~]# tar xf node-v8.7.0-linux-x64.tar 
[root@backup ~]# ll
total 57496
drwxrwxr-x 6 emm  emm      4096 Oct 11 20:04 node-v8.7.0-linux-x64
-rw-r--r-- 1 root root 58869760 Oct 31 16:28 node-v8.7.0-linux-x64.tar

2.安装apidoc

[root@backup local]# ln -s /usr/local/nodejs/bin/node /usr/local/bin
[root@backup local]# /usr/local/nodejs/bin/npm install apidoc -g 

3.使用apidoc

 放入你需要的文件和生成的目录（测试）

[root@backup inputfile]# ll
total 8
-rw-r--r-- 1 root root 190 Nov  1 17:21 apidoc.json
-rw-r--r-- 1 root root 169 Nov  1 17:21 test.js

[root@backup tmp]# apidoc -i inputfile/ outfile/
info: Done.
出现这样的字样表示完成默认会到doc下