apidoc根據代碼注釋生成接口文檔過程

• 首先要确認你的系統安裝了

  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就可以看到接口文檔啦。