ApiDoc工具使用簡介

apidoc是乙個介面文件，它的建立方式是基於你的源**的介面備註。我們只需要給介面寫好相應的文件，然後使用apidoc生成介面文件工具生成文件，便於管理和檢視

安裝配置

1.安裝apidoc

npm install apidoc -g

檢視是否安裝成功

node -v

npm -v

2.給介面新增文件（官方示例），新增在controller入口方法前面

/**

*@api  /user/:id request user information
*@apiname getuser
*@apigroup user
* *@apiparam  id users unique id.
* *@apisuccess  firstname firstname of the user.
*@apisuccess  lastname  lastname of the user.
*/

}

public/apidoc/

就這樣就可以開啟你專案中生成的對應的apidoc目錄，就會現在對應文件

參考apidoc官網

APIDOC安裝使用

1 安裝node 2 修改node預設映象 npm config list檢視配置項 npm config set registry 3 全域性安裝apidoc npm install apidoc g 4 新建資料夾demo 5 建立apidoc.json檔案和test.php檔案 apidoc....

APIDOC使用教程

nodejs install apidoc install npm install g apidocinstall check 使用win r快捷鍵開啟執行視窗，在文字框中輸入cmd並回車開啟windows shell。node v npm v apidoc vrun command 引數 描述 i...

介面文件生成工具 apidoc

apidoc在您的源 中通過建立api注釋從而生成api說明文件。我們以express的專案為例 1 建立apidoc.json 2 我們在routes資料夾下建立api資料夾，用於書寫介面注釋說明,例如 api news newscontent 新聞詳情 apiversion 1.0.0 apin...