apiDoc使用指南

2021-10-09 13:02:37 字數 2115 閱讀 4133

安裝:

1: 需要先安裝node.js(安裝node.js相關部落格)

2: node.js安裝完成後使用命令:

npm install apidoc -g

在你的專案根路徑下新建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)

@api ( @api path [title] ) http介面呼叫方法,路徑及名稱

@apiversion ( @apiversion version ) api版本號

@apiname (@apiname name) api名稱

@apigroup (@apigroup name) api分組

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

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

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

@apisucces***ample( @apisucces***ample [title] example ) 介面成功返回樣例

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

@apierrorexample (@apierrorexample [title] example ) 介面失敗返回樣例

@apidefine (@apidefine name [title] [description] ) 類似於巨集定義,可以被引用

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

cd到apidoc.json所在路徑(即專案根目錄)執行命令:

apidoc -i src/ -o apidoc/

Ubuntu apt 使用指南

起初gnu linux系統中只有.tar.gz。使用者必須自己編譯他們想使用的每乙個程式。在debian出現之後,人們認為有必要在系統中新增 一種機制用來管理安裝在計算機上的軟體包。人們將這套系統稱為dpkg。至此著名的 package 首次在gnu linux上出現。不久之後紅帽子也 開始著手建立...

CImageList使用指南

1.綜述 在mfc 中cimagelist 類封裝了 影象列表控制項的功能,影象列表是乙個具有相同大小的 影象 可以是不同 型別 的集合,其主要用於 應用程式中大規模 圖示的儲存。該控制項是不可 見的,通常與其它如 clistbox ccombobox ccomboboxex ctabctrl 以及...

CImageList使用指南

cimagelist使用指南 1.綜述 在 mfc中cimagelist類封裝了影象列表控制項的功能,影象列表是乙個具有相同大小的影象 可以是不同型別 的集合,其主要用於應用程式中大 規模圖示的儲存,該控制項是不可見的。通常與其它如clistbox,ccombobox,ccomboboxex以及ct...