linux apidoc的安裝和使用

1.先去官網下載已編譯好的安裝包

以Centos7.4 64位為例, 下載地址: https://nodejs.org/dist/v8.1.2/node-v8.1.2-linux-x64.tar.xz

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​

解壓好的目錄移動到指定位置:

mv node-v8.1.2-linux-x64 /usr/local/nodejs​

做命令連接:

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

測試版本號:

node -v

完成​

2：安裝apidoc 

/usr/local/nodejs/bin/npm install apidoc -g

安裝成功一般提示：

安裝失敗可能是由於權限不足，重新加上sudo進行安裝： 

sudo /usr/local/nodejs/bin/npm install apidoc -g 

提示“/usr/bin/env: node: No such file or directory” ，需執行以下命令解決

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

3.創建測試文件，apidoc.json文件和test.php文件

apidoc.json:

{ "name": "****",
  "title": "****API",
  "description":"****API接口文檔",
  "url" : "http://api.demo.com",
  "version": "0.1.0" }

test.php文件

<?php /** * * @api {get} /user/{id} * @apiDescription 獲取用戶信息接口描述 * @apiGroup User * @apiName getUserInfo * @apiParam {Number} id 用戶ID * @apiVersion 0.1.0 * * * @apiExample {curl} 訪問示例： * curl -i http://api.demo.com/user/4711 * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */
function GetUser($id){}

4：生成對應的接口文檔 
采用下面的命令：

/usr/local/nodejs/bin/apidoc -i input_your_file/ -o output_your_file/

其中input_your_file放置的是事先按照apidoc格式編寫好的js文件，output_your_file則指定了生成的html的位置。 

例子如下：

 

 

注意：出現如下錯誤提示error: No files found，可能是某些文件導致出現的問題，需要自行確認查找那些文件影響了文檔的生成