APIDOC 推薦乙個API生成器

一、apidoc

(1)官網：

(2)頁面簡單

二、使用：

①安裝nodejs。然後npm install apidoc -g

②在自己的專案下新建乙個json檔名為：apidoc.json

@restcontroller("/users")

public class testcontroller /test/getbyid 根據id查詢使用者
* @apigroup users
* @apiversion 1.1.0
* @apidescription 根據id查詢使用者
* @apiheader authorization 使用者授權token
* @apiheader firm 廠商編碼
* @apiheaderexample header-example:
* * @apiparam id userid[必填]
* @apisuccess status 資訊
* @apisuccess msg 返回碼
* @apisuccess data 資料
* @apisucces***ample 成功返回樣例：
* * }
* @apierrorexample 錯誤返回樣例：
* * 
* * 
*/entity.setid(id);
entity.setaccesstoken("1");
entity.setisflag("1");
return serverresponse.createbysuccess("success", entity);
}}

apidoc -i src/ -o apidoc/

⑤ 然後在apidoc這個目錄下，開啟index.html。就可以檢視。

apiDoc 生成api文件

安裝node.js 安裝apidoc npm install apidoc g在你的專案根目錄下新建apidoc.json檔案，該檔案描述了專案對外提供介面的概要資訊如名稱 版本 描述 文件開啟時瀏覽器顯示標題和介面預設訪問位址。apidoc.json apidefine rknotfoundexc...

ApiDoc 自動生成API文件

1 確認已經安裝node.js 可以使用npm命令 否則要先安裝node 2 安裝apidoc 命令列執行 npminstall apidoc g 3 在專案的當前目錄下編寫乙個指令碼genapidoc.bat 內容為 apidoc o doc apidoc pause 將生成的api文件 o 輸出...

apiDoc自動生成api文件

在自定生成api文件方面以前都是使用swagger.json結合swagger工具來生成文件，偶然發現了apidoc這個生成api的工具，發現使用起來比swagger更加簡單，下面整理一下使用過程 首先通過npm全域性安裝apidoc npm install apidoc g 使用的時候最主要是參考...