apidoc: Inline Documentation for RESTful web APIs

apidoc：Inline Documentation for RESTful web APIs

安装 apidoc的过程记录：

$ npm install apidoc -g

The program 'npm' is currently not installed. You can install it by typing:

sudo apt-get install npm

缺失npm，所以安装npm

$ sudo apt-get install npm

安装 apidoc

$ sudo npm install apidoc -g

$ apidoc -h

/usr/bin/env: node: No such file or directory

没找到node，所以建立链接

$ sudo ln -s /usr/bin/nodejs /usr/bin/node

$ apidoc -h

/usr/local/lib/node_modules/apidoc/node_modules/fs-extra/lib/index.js:3

const assign = require('./util/assign')

^^^^^

SyntaxError: Use of const in strict mode.

……

原因是node的版本太旧。

解决方法是升级node到新版本。

首先，安装 n，供升级node使用

$ sudo npm install -g n

通过 n 安装最新的 node。

$ sudo n latest

最新版本的node

$ /usr/local/bin/node -v

v8.6.0

默认使用的是旧版本node（链接）

$ node -v

v0.10.25

删除旧版本的node

$ sudo rm /usr/bin/node

建立新版本的node的链接

$ sudo ln /usr/local/bin/node /usr/bin/

查看node版本

$ node -v

v8.6.0

查看npm版本

$ npm -v

1.3.10

升级npm

$ sudo npm install -g npm

$ npm -v

5.4.2

$ apidoc -h 正常了

使用apidoc：

$ apidoc -i MyProject -o MyProject_apidoc -t templates

将MyProject_apidoc下的文件放到 Apache2的目录（默认是 /var/www/html/）下，重启apache2，即可从页面访问apidoc。