SpringBoot整合系列 整合Swagger2

2022-02-09 12:46:52 字數 2019 閱讀 3171

io.springfox

springfox-swagger2

2.7.0

io.springfox

springfox-swagger-ui

2.7.0

一般無配置項,必要時可以新增自定義配置項,在配置類中讀取
// swagger2的配置內容僅僅就是需要建立乙個docket例項

@configuration

@enableswagger2 //啟用swagger2

public class swagger2config

private apiinfo apiinfo()

}

通過@configuration註解,讓spring-boot來載入該類配置。再通過@enableswagger2註解來啟用swagger2config。

再通過createrestapi方法建立docket的bean之後,

apiinfo方法用來建立該api的基本資訊(這些基本資訊會展現在文件頁面中)。

select() 函式返回乙個 apiselectorbuilder 例項用來控制哪些介面暴露給swagger2來展現。

一般採用指定掃瞄的包路徑來定義

swagger會掃瞄該包下所有controller定義的api,並產生文件內容(除了被@apiignore指定的請求)

@restcontroller

@log4j2

@api(description = "使用者介面")

public class userapi

@apioperation(value = "更新使用者狀態", notes = "根據給定的使用者id修改使用者狀態",response = responseentity.class,httpmethod = "post")

public responseentityupdateuser(final usestate usestate, int useid)

@apioperation(value = "更新使用者手機號", notes = "根據給定的使用者id修改使用者手機號",response = responseentity.class,httpmethod = "post")

public responseentityupdateusephonenum(final string usephonenum, int useid)

@apioperation(value = "刪除使用者", notes = "根據給定的使用者id刪除乙個使用者",response = responseentity.class,httpmethod = "delete")

public responseentitydeleteuser(final int useid)

@apioperation(value = "查詢使用者", notes = "根據給定的使用者id獲取乙個使用者",response = responseentity.class,httpmethod = "get")

public responseentitygetuser(final int useid)

@apioperation(value = "查詢使用者", notes = "根據給定的使用者資訊查詢使用者",response = responseentity.class,httpmethod = "post")

public responseentity> getusers(final user user)

}

@apimodel(value = "使用者模型")

public class user

http://localhost:8080/swagger-ui.html
可得到如下介面:

SpringBoot整合Redis(單機 集群)

前面redis弄了那麼多,就是為了在專案中使用.那這裡,就分別來看一下,單機版和集群版在springboot中的使用吧.在裡面,我會同時貼出jedis版,作為比較.1.pom.xml org.springframework.boot spring boot starter data redis 1....

spring boot 整合多個kafka集群

有時候我們的整合軟體需要在專案中整合多個kafka集群,實現步驟如下 步驟一 配置第二個kafka檔案 步驟二 定義第二個kafka的實現類 description project createdate created in 2019 4 26 18 20 author xiaozm configu...

SpringBoot如何整合kafka集群

目錄結構 pom依賴 org.springframework.boot spring boot starter parent 2.0.1.release org.springframework.kafka spring kafka org.springframework.boot spring bo...