首先安裝node.js
下載最新版node.js 安裝node.js
https://nodejs.org/en/
判斷node.js和npm是否安裝正常
node -v npm -v
安裝ApiDoc,最好使用git安裝
npm install apidoc -g
查看ApiDoc是否安裝成功
apidoc -v
安裝成功之后，在項目更目錄創建文件apidoc.json (文件創建之后刪除所有注釋)
{ "name": "appleFarm", //文檔項目名 "title": "appleFarmAPI", //html標題 "description":"appleFarmAPI接口文檔", //文檔描述 "url" : "https: //xxx.com",//公共接口地址 "version": "0.1.0" //文檔版本 }
寫好注釋之后在更目錄輸入命令
apidoc -i Application/ -o apidoc/
Application 為注釋目錄文件夾 apidoc為新建apidoc輸出目錄
注釋例子：
/** * @api {post} /tanfangri/get-by-id 根據戒毒所ID取內容 * @apiDescription * @apiVersion 0.1.0 * * @apiParam {string} jiedusuo_id 戒毒所ID * * * @apiGroup tanfangri * * @apiSuccessExample * { "code": 1, "message": "相關內容" } */
注釋說明
@api {get} /users/:user_id Request User Information
最主要的參數，”{get}”定義了HTTP請求是GET，API地址是”/users/:user_id”，文檔中API的名稱是”Request User Information”。
@apiVersion 0.1.0
API的版本號，默認顯示在API名稱的右方。該參數可用來在不同的版本之間做比較，后面會介紹。
@apiName GetUser
API名稱，不影響文檔。
@apiGroup User
API分組名，文檔內容中和菜單欄中同一組的API會在一同顯示，方便閱讀。
@apiPermission admin
API的訪問權限，文檔中默認會API地址下面顯示。沒有權限要求的話，此項可以省略。
@apiDescription API to get the user information.
API的詳細描述，默認顯示在API名稱的下方。
@apiExample Example usage:
API調用示例，該參數的下一行就是示例的內容，直到有空行結束。可以定義多個@apiExample，默認在文檔中會以標簽形式列出，標簽名就是”Example usage:”。
@apiParam {Number} user_id The user’s unique ID.
API參數字段介紹，”{Number}”定義了字段類型，”user_id”是字段名稱，后面則是字段描述。可以定義多個@apiParam字段。
@apiSuccess {String} name Name of the User.
API成功后返回的字段，如同@apiParam，”{String}”定義了字段類型，”name”是返回字段名稱，后面則是字段描述。可以定義多個@apiSuccess字段。
@apiSuccessExample {json} Success-Response:
顯示一個API成功返回后Response響應的示例，”{json}”代表響應體是JSON類型。該參數的下行就是響應體內容，直到有空行結束。可以定義多個@apiSuccessExample，默認在文檔中會以標簽形式列出，標簽名就是”Success-Response:”。
@apiError UserNotFound User was not found.
API發生錯誤后的返回，”UserNotFound”是錯誤名稱，后面則是錯誤描述。可以定義多個錯誤返回。
@apiErrorExample {json} Error-Response:
顯示一個API錯誤返回后Response響應的示例，”{json}”代表響應體是JSON類型。該參數的下行就是響應體內容，直到有空行結束。可以定義多個@apiErrorExample，默認在文檔中會以標簽形式列出，標簽名就是”Error-Response:”。
@apiSampleRequest http://localhost:5000/users/:user_id
文檔提供的API Sample測試的地址。其實在”apidoc.json”中配過”sampleUrl”項后，此參數即可省去，除非這個API的測試URL比較特殊，需特別指定。