apiDoc 生成api文件

2021-10-02 00:06:36 字數 2340 閱讀 8814

安裝node.js

安裝apidoc

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

apidoc.json

/**


* * @apidefine rknotfoundexception


* * @apierror rknotfoundexception 描述


* @api /v3.1/ues/:sn/rt-info 描述


* @apiversion 3.1.0


* @apiname getuerealtimeinfo


* @apigroup ue


* * @apiheader authorization 使用者授權token


* @apiheader firm 廠商編碼


* @apiheaderexample header-example:


* 


* * @apiparam sn 裝置序列號


* * @apisuccess sn 裝置序列號


* @apisuccess status 裝置狀態


* @apisuccess soc 電池電量百分比


* @apisuccess voltage 電池電壓


* @apisuccess current 電池電流


* @apisuccess temperature 電池溫度


* @apisuccess reporttime 上報時間(yyyy-mm-dd hh:mm:ss)


public uerealtimeinfo getuerealtimeinfo(@requestheader(constants.header_login_user_key) long userid, @pathvariable("sn") string sn)
@api  path [title]
http介面呼叫方法、路徑及名稱

@apiversion version
api 版本號

@apiname name
api 名稱

@apigroup name
api 分組

@apiheader [(group)]  [field=defaultvalue] [description]
請求頭引數

@apiparam [(group)]  [field=defaultvalue] [description]
請求引數

@apisuccess [(group)]  field [description]
返回資料描述

@apisucces***ample  [title]


example
介面成功返回樣例

@apierror [(group)]  field [description]
介面失敗描述

@apierrorexample  [title]


example
介面失敗返回樣例

@apidefine name [title]


[description]
類似於巨集定義，可以被引用

@apiuse name
使用@apidefine定義的描述

更詳細的說明請參考官方文件

cd到apidoc.json所在路徑（即專案根目錄）執行如下命令即可

apidoc -i src/ -o apidoc/
apidocjs官方** 

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 使用的時候最主要是參考...

apidoc文件生成

1 首先要確認你的系統安裝了nodejs，然後執行npm install g apidoc即可。2 配置apidoc，在你的專案下建立apidoc.json檔案，apidoc.json說明 該檔案可以隨便放置，主要執行apidoc i src o apidoc 命令時，是在該檔案目錄下就行，具體下面...