IDEA SpringBoot 項(xiàng)目配置Swagger2的詳細(xì)教程
- 原先前后端分離的api文檔開啟了前后端相互撕逼的對(duì)接之路
- api更新不及時(shí)導(dǎo)致對(duì)接失敗，以及存在測(cè)試不夠方便，而swagger則很好的解決了這個(gè)問(wèn)題
在項(xiàng)目中也經(jīng)常用到swagger2，于是動(dòng)手記錄一下swagger2配置過(guò)程，希望能帶來(lái)一點(diǎn)幫助。
在SpringBoot項(xiàng)目當(dāng)中使用Swagger主要分為以下幾步：
1、SpringBoot-web項(xiàng)目并添加pom.xml依賴
2、編寫HelloController，測(cè)試成功運(yùn)行
3、創(chuàng)建一個(gè)SwaggerConfig類，配置swagger-ui
流程確實(shí)是很簡(jiǎn)單的，但是能真正的在項(xiàng)目中活用swagger卻不是那么簡(jiǎn)單
1、SpringBoot-web項(xiàng)目并添加pom.xml依賴
可以直接在maven repository搜索
多最一句，一般在選擇maven依賴時(shí)，我們趨向于選擇最穩(wěn)定版本，可以通過(guò)Usages判斷，盡量不要選擇最新版，及時(shí)并沒(méi)有什么影響。詳細(xì)經(jīng)歷過(guò)版本沖突和版本不兼容的小伙伴應(yīng)該深有體會(huì)。
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
2、編寫HelloController，測(cè)試成功運(yùn)行
package cn.swpu.myblog.controller;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Controller
@Api(tags = "測(cè)試-HelloWorld") //這個(gè)controller下的所有接口的描述
public class HelloController {
@ApiOperation("測(cè)試Swagger2") //顯示在接口的信息說(shuō)明
@RequestMapping(value = "/test", method = RequestMethod.GET) //請(qǐng)求路徑和類型
public void testSwagger(){
}
}
3、創(chuàng)建一個(gè)SwaggerConfig類，配置swagger-ui
package cn.swpu.myblog.config;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
}
然后就可以根據(jù)你的端口訪問(wèn)swagger-ui了，例如我的是8099
http://localhost:8099/swagger-ui.html#/
至此IDEA 繼承Swagger就可以了，但這僅僅只是個(gè)開始，swagger還是有很多的實(shí)用技巧。
到此這篇關(guān)于IDEA SpringBoot 項(xiàng)目配置Swagger2的詳細(xì)教程的文章就介紹到這了,更多相關(guān)IDEA SpringBoot 項(xiàng)目配置Swagger2內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java黑盒測(cè)試之nextDate函數(shù)測(cè)試
這篇文章主要介紹了Java黑盒測(cè)試之nextDate函數(shù)測(cè)試,文中有非常詳細(xì)的代碼示例,對(duì)正在學(xué)習(xí)Java黑盒測(cè)試的小伙伴們有很大的幫助哦,需要的朋友可以參考下2021-05-05
繼承就是可以直接使用前輩的屬性和方法。自然界如果沒(méi)有繼承，那一切都是處于混沌狀態(tài)。多態(tài)是同一個(gè)行為具有多個(gè)不同表現(xiàn)形式或形態(tài)的能力。多態(tài)就是同一個(gè)接口，使用不同的實(shí)例而執(zhí)行不同操作2022-04-04
Java?POI導(dǎo)出Excel時(shí)合并單元格沒(méi)有邊框的問(wèn)題解決
這篇文章主要給大家介紹了關(guān)于Java?POI導(dǎo)出Excel時(shí)合并單元格沒(méi)有邊框的問(wèn)題解決辦法,文中通過(guò)代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用java具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2023-07-07
MybatisPlus自帶的queryWrapper實(shí)現(xiàn)時(shí)間倒序方式
這篇文章主要介紹了MybatisPlus自帶的queryWrapper實(shí)現(xiàn)時(shí)間倒序方式，具有很好的參考價(jià)值，希望對(duì)的有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-01-01
gateway和jwt網(wǎng)關(guān)認(rèn)證實(shí)現(xiàn)過(guò)程解析
這篇文章主要介紹了gateway和jwt網(wǎng)關(guān)認(rèn)證實(shí)現(xiàn)過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-11-11
如何利用Map與函數(shù)式接口來(lái)實(shí)現(xiàn)去除if else
這篇文章主要介紹了如何利用Map與函數(shù)式接口來(lái)實(shí)現(xiàn)去除if else問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-07-07
如何通過(guò)idea實(shí)現(xiàn)springboot集成mybatis
這篇文章主要介紹了如何通過(guò)idea實(shí)現(xiàn)springboot集成mybatis,使用springboot 集成 mybatis后,通過(guò)http請(qǐng)求接口,使得通過(guò)http請(qǐng)求可以直接操作數(shù)據(jù)庫(kù),本文結(jié)合實(shí)例代碼給大家介紹的非常詳細(xì),需要的朋友可以參考下2023-09-09
如何正確控制springboot中bean的加載順序小結(jié)篇
這篇文章主要介紹了如何正確控制springboot中bean的加載順序總結(jié)，本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-07-07
Java中如何將String轉(zhuǎn)JSONObject
這篇文章主要介紹了Java中如何將String轉(zhuǎn)JSONObject,String類型轉(zhuǎn)JSONObject，下面有兩種方式可以進(jìn)行轉(zhuǎn)換，本文結(jié)合實(shí)例代碼給大家介紹的非常詳細(xì)，需要的朋友可以參考下2023-05-05
Mybatis關(guān)聯(lián)查詢結(jié)果集對(duì)象嵌套的具體使用
在查詢時(shí)經(jīng)常出現(xiàn)一對(duì)多”的關(guān)系,所有會(huì)出現(xiàn)嵌套對(duì)象的情況，本文主要介紹了Mybatis關(guān)聯(lián)查詢結(jié)果集對(duì)象嵌套的具體使用，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-02-02