• 首先要確認你的系統安裝了nodejs，然後執行npm install -g apidoc即可。
• 配置apidoc，在你的專案下建立apidoc.json檔案

{
    "name": "測試APIs",   
    "version": "1.0.0",                
    "description": "介面測試",
    "title": "test APIs",
    "url" : "您的介面API訪問的地址",
    "sampleUrl" : "您的測試介面API的訪問地址"
}

• 程式碼書寫過程中，書寫註釋，註釋樣例如下

•     /**
       * @api {post} /api/salesman/login 業務員登入
       * @apiGroup salesman
       * @apiName salesman/login
       * @apiDescription 業務員登入
       *
       * @apiParam {string}  username 業務員手機/姓名
       * @apiParam {string}  password 密碼
       *
       * @apiSuccessExample {json} 登入成功返回:
       * {
       * "code": 0,
       * "msg": "登入成功!",
       * "data": {"token":"5e429a4bb763fa23bfd233df493c87f1"}
       * }
       *
       */
   
  

  生成文件，執行如下命令

• apidoc -i api/ -o public/apidoc/

  其中，-i後邊的是介面檔案的目錄所在，-o後邊的是輸出靜態檔案的目錄所在。

• 執行完後，會在相應目錄下生成好靜態檔案，然後點選index.html就可以看到介面文件啦。