快速根據注釋生成接口文檔網頁工具——Apidoc的使用教程

 

1，安裝Node.js的npm工具環境：

 

   如有不懂，請看我的博客：“https://blog.csdn.net/sinat_28371057/article/details/81612661“

 

2，npm環境搭好后，控制台運行命令：

 

npm install apidoc -g　　

安裝完成后顯示如下界面：

 

     2，在接口程序文件中添加apidoc文檔注釋

 

/**
          * @apiDefine userApiStr 用戶接口文檔 
          */
        
        /**
         * @api {POST} /login 用戶登錄
         * @apiName api測試
         * @apiGroup userApiStr
         * @apiVersion 1.0.0
         * @apiDescription 用於用戶登錄
         * @apiParam {String} userName 用戶名
         * @apiParam {String} password 密碼
         * @apiParamExample {json} 請求樣例：
         *                ?userName=張三&password=11223344
         * @apiSuccess (200) {String} msg 信息
         * @apiSuccess (200) {String} code 0 代表無錯誤 1代表有錯誤
         * @apiSuccess (200) {String} user 用戶信息
         * @apiSuccess (200) {String} userId 用戶id
         * @apiSuccessExample {json} 返回樣例:
         *                {"code":"0","msg":"登錄成功","userId":"fe6386d550bd434b8cd994b58c3f8075"}
         */

 

    3，生成apidoc文檔，在當前注釋文件目錄下輸入命令

 

apidoc -i C:\WEB\modules\src\ -o C:\WEB\modules\src\apidocs\

# apidoc    -i    注釋文件所在目錄路徑     生成的apidoc文檔所在目錄路徑

      完成后顯示了生成的apidoc文件目錄：

 

      打開  ”index.html“ 查看生成的接口文檔

 

 

  到這里，apidoc就成功跑起來了