swaggerAPI介面文件分組

2021-10-02 22:26:48 字數 1948 閱讀 3384

swagger是乙個深度整合的後台api文件工具,極大的方便了後端的開發測試以及和前端的對接工作。但是當專案中的介面越來越多時,會導致頁面上的介面過多,檢視起來不是很方便,這時可以使用swagger的分組功能將介面進行分組分頁展示。分組的規則可以基於路徑和註解等,下面主要介紹下基於註解的分類,這種方法比較靈活。

先上結果

分組一

分組二

首先定義用於標誌分組的註解

然後在swagger配置類裡面建立多個docket

**如下

@configuration

@enableswagger2

public

class

swagger2

@bean

public docket createapi2()

private list

securityschemes()

private list

securitycontexts()

list

defaultauth()

private apiinfo apiinfo

(string title)

}

需要注意的是groupname不能重複,否則會報錯,withmethodannotation方法目前只支援單個註解,有點不太方便。

然後是在最終的介面上新增上對應的註解就行了

@restcontroller

@api

(tags =

"功能測試介面"

,description =

"用於測試基礎功能,沒有實際業務含義")(

"api/test"

)@validated

public

class

tabtestcontroller

@apioperation

("新增"

)@swaggerapi2

public long insert

(@requestbody

@validated

() tabtestvo tabtest)

("insertbatch"

)@apioperation

("批量新增"

)@swaggerapi2

boolean

insertbatch

(@requestbody

@validated

() list

tabtestvos)

@apioperation

("修改"

)@swaggerapi1

public

boolean

update

(@requestbody

@validated

() tabtestvo tabtest)

("updatebatch"

)@apioperation

("批量修改"

)@swaggerapi1

public

boolean

updatebatch

(@requestbody

@validated

() list

tabtestvos)

@apioperation

("刪除"

)@swaggerapi1

public

boolean

del(long id)

}

yapi 介面文件 介面文件神器YApi

阿八個人部落格 1190000020220258 什麼是yapi github 官網上是這麼介紹的 yapi 是乙個可本地部署的 打通前後端及qa的 視覺化的介面管理平台 可以這麼說yapi兼具swagger,rap2,postman的各項優點why yapi 如果你想要乙個好用的介面管理平台,那麼...

Android 介面文件

前言 一 設定描述 設計描述,主要是介紹專案介面文件的業務及主要功能介紹,有互動方式 json資料互動格式 命名規則等做細分講解。1 介面的呼叫方式 移動端通過webservice和其他通用的請求方式,呼叫伺服器介面,返回json資料。2 json的結構 請求失敗示例 請求成功示例 字段解析 sta...

介面文件格式

幻寵大陸 專案協議文件 協議格式說明 遊戲系統中協議是由兩部分組成 協議頭 協議體。其中協議頭的資料長度為固定。如下顯示 客戶端傳送的訊息格式 字段意義 字段型別 說明訊息長度 int描述協議體的長度,包括當前 訊息頭short 協議 id 訊息回執碼 short 壓縮或加密的標識,或者是回執碼 訊...