npm: Nodejs下的包管理器。
1.安裝npm：在node.js官網https://nodejs.org/en/下載node.js並安裝
2.判斷是否安裝完成，命令列輸入 npm-v
3.若提示npm命令不存在，則將根目錄下得node_modules新增到系統環境變數，重試。
4.解除安裝npm;首先刪除安裝目錄，然後刪除系統目錄的npm目錄，最後在控制皮膚中解除安裝node.js.
5.安裝apidoc 官網文件apidocjs.com/
安裝命令：npm install apidoc -g
專案根目錄新增apidoc.json配置如下：（具體引數配置檢視官網）
新建一個根目錄存放生成的文件資訊且在controller中配置：（具體引數配置檢視官網）
/**
- @api {post} /supplier/Info/updateSupplierInfo 更改供應商資訊
- @apiName updateSupplierInfo
- @apiGroup Supplier
- @apiParam {int} supplier_code 供應商編碼
- @apiParam {string} name 供應商名稱
- @apiParam {string} en_name 供應商英文名稱
- @apiParam {string} en_name 供應商英文名稱
- @apiParam {string} short_name 供應商 ID（簡稱）
- @apiParam {float} reg_capital 註冊資本
- @apiParam {string} product_country 主營產品和國家
- @apiParam {string} first_product 初次詢價商品
- @apiParam {date} build_at 成立時間
- @apiParam {int} province_id 省id
- @apiParam {string} province_name 省份名
- @apiParam {int} city_id 城市id
- @apiParam {string} city_name 城市名
- @apiParam {string} collaboration 合作建議
- @apiParam {string} brand_productivity 合作品牌和產量
- @apiParam {string} coordinate 配合度
- @apiParam {json} contact_person 聯絡人，陣列，每個元素包含姓名name，電話phone,郵箱email，是否主要聯絡人is_base欄位
- @apiParam {json} qua_files 資質檔案，陣列，每個元素包含name，file_type和path欄位
- @apiParam {json} other_files 其他檔案，陣列，每個元素包含name，file_type和path欄位
- @apiParam {string} account_info 賬號資訊
- @apiParam {string} account_period 賬期
- @apiParam {string} qualification 企業資質
- @apiParam {string} collaboration 合作建議
- @apiParam {string} address 廠址
- @apiParam {string} oracle_status 狀態
- @apiParam {string} currency 主要幣種
- @apiParam {string} capacity 總體產能
- @apiParam {string} web_url 網址
- @apiParam {string} delivery_time 交期
- @apiError {string} code 錯誤碼碼412.供應商修改資訊失敗、
- 450.供應商名稱不能為空、451.英文名不能為空、452.ID（簡稱）不能為空、453.規模不能為空，454.註冊資本不能為空
- 455.成立時間不能為空、456.廠址不能為空、457.聯絡資訊不能為空、458.ID（簡稱）格式錯誤!，459.成立時間格式錯誤
- 460.ID（簡稱）重複!、461.該資料暫時不能修改
- @apiSuccessExample Success-Response:
- { * “code”: 200, //代表更改成功
- “message”: “成功,介面響應時間：0.3272318840秒，佔用記憶體：3,311.10KB”,
- “data”:null, * } * * @apiErrorExample {json} Error-Response:
- { * “code”: 460, * “message”: “ID（簡稱）重複!,介面響應時間：0.0382719040秒，佔用記憶體：3,258.92KB.”,
- “data”: null * } */
在命令列視窗輸入：apidoc -i application/supplier/controller/ -o apidoc/
注意：-i 後面的是你寫註釋的檔案相對於apidoc.json的路徑，-o後面是生成的檔案路徑相對於apidoc.json
本作品採用《CC 協議》，轉載必須註明作者和本文連結