apidoc: Inline Documentation for RESTful web APIs
阿新 • • 發佈：2019-02-04
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。