SpringBoot整合swagger介面開發

2021-10-14 20:42:49 字數 1226 閱讀 4415

1.在自己的專案pom檔案裡面必須要新增的兩個依賴

io.springfox


springfox-swagger2


2.9.2


io.springfox


springfox-swagger-ui


2.9.2
2.新增配置檔案，在配置類裡面新增

@configuration

@enableswagger2

其中@configuration表示這個類是乙個配置檔案，@enableswagger2表示整合swagger介面，在配置檔案裡面新增以下內容：

@bean


public docket createrestapi()
關鍵點：

.apis(requesthandlerselectors.basepackage("com.yzj.controller"))
這是要掃瞄的controller檔案，

.title("springboot整合swagger")


.description("springboot整合swagger，詳細資訊......")


.version("9.0")


// .contact(new contact("啊啊啊啊","blog.csdn.net","[email protected]"))


.license("the apache license")


.licenseurl("")


.build());
這些都是swagger檔案的描述資訊，不太重要嗎，主要是自己看，能看懂都行，只要在controller已經配置好了get,post,put等介面，直接在瀏覽器裡面輸入url:http://localhost:8080/swagger-ui.html#/即可展示頁面如下

這些都是自己寫的介面，可以直接在裡面測試

可以直接進行測試，返回json串

SpringBoot開發案例之整合Swagger篇

前段時間整合過的乙個支付服務，由於使用了spring boot快速開發，但是又懶得寫詳細的文件介紹，便順手就把swagger整合進來了，對支付服務進行分組api展示，如上圖。我有幾張阿里雲幸運券分享給你，用券購買或者公升級阿里雲相應產品會有特惠驚喜哦！把想要買的產品的幸運券都領走吧！快下手，馬上就要...

SpringBoot開發案例之整合Swagger篇

前段時間整合過的乙個支付服務，由於使用了spring boot快速開發，但是又懶得寫詳細的文件介紹，便順手就把swagger整合進來了，對支付服務進行分組api展示，如上圖。swagger 是乙個規範和完整的框架，用於生成 描述 呼叫和視覺化 restful 風格的 web 服務。總體目標是使客戶端...

SpringBoot如何優雅地使用Swagger2

spring boot 框架是目前非常流行的微服務框架，我們很多情況下使用它來提供 rest api。而對於 rest api 來說很重要的一部分內容就是文件，swagger 為我們提供了一套通過 和註解自動生成文件的方法，這一點對於保證 api 文件的及時性將有很大的幫助。本文將使用 swagge...