天天看點

Spring Boot 整合 Swagger(knife4j)

1、建立一個Spring Boot 項目

2、配置Swagger

2.1、 pom檔案引入

2.2、 SwaggerConfig檔案配置資訊

2.3、controller層

2.4、application.yml(或者是:application.properties)

2.5、項目入口檔案加注釋

2.6、運作項目使用Swagger調試接口

此步驟不進行較長的描述;

Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)

此檔案所在地方隻要在 src 檔案夾下即可:

Spring Boot 整合 Swagger(knife4j)

代碼:

上述代碼可複制直接使用,其中唯一必須要改的便是 Swagger 需要掃描的 Controller 層的路徑;

Spring Boot 整合 Swagger(knife4j)

此代碼中隻需要了解以下幾個點即可:

@Api(value = “Swagger-module”, tags = “Swagger-module”) :代表的是子產品名,在swagger平台中會以作為每個子產品的名稱

@ApiOperation(value = “測試”, notes = “随意傳入一個字元串”):代表的是子產品下的各個接口的名稱;

另外需要注意的是,一般情況下如果子產品下沒有接口或者所有接口均沒有添加swagger的接口注解,那麼在swagger的調試平台中此子產品也不會顯示;

Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)

項目正常啟動後在浏覽器中輸入:http://localhost:2021/doc.html#/home (上一步中的服務端口設定是多少,不要忘記把此位址的端口也要保持一緻;),回車後會進入如下界面:

Spring Boot 整合 Swagger(knife4j)

如此情況即算是Swagger已經配置好了,下面調試一下接口試試;

打開自定義的子產品名,找到其下的接口,如下所示:

Spring Boot 整合 Swagger(knife4j)

點選 測試 接口中 調試 按鈕,并在 id 參數欄中輸入任意字元串後點選 發送 會得到如下所示的資料:

Spring Boot 整合 Swagger(knife4j)

說明接口調用成功并成功傳回了傳入資料的MD5加密後的資料,是以,調試成功;

繼續閱讀