久久r热视频,国产午夜精品一区二区三区视频,亚洲精品自拍偷拍,欧美日韩精品二区

您的位置:首頁技術文章
文章詳情頁

IDEA SpringBoot 項目配置Swagger2的詳細教程

瀏覽:3日期:2023-04-12 14:37:51
原先前后端分離的api文檔開啟了前后端相互撕逼的對接之路 api更新不及時導致對接失敗,以及存在測試不夠方便,而swagger則很好的解決了這個問題

在項目中也經常用到swagger2,于是動手記錄一下swagger2配置過程,希望能帶來一點幫助。

在SpringBoot項目當中使用Swagger主要分為以下幾步:

1、SpringBoot-web項目并添加pom.xml依賴

2、編寫HelloController,測試成功運行

3、創建一個SwaggerConfig類,配置swagger-ui

流程確實是很簡單的,但是能真正的在項目中活用swagger卻不是那么簡單

1、SpringBoot-web項目并添加pom.xml依賴

可以直接在maven repository搜索

多最一句,一般在選擇maven依賴時,我們趨向于選擇最穩定版本,可以通過Usages判斷,盡量不要選擇最新版,及時并沒有什么影響。詳細經歷過版本沖突和版本不兼容的小伙伴應該深有體會。

IDEA SpringBoot 項目配置Swagger2的詳細教程

<!-- 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,測試成功運行

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 = '測試-HelloWorld') //這個controller下的所有接口的描述public class HelloController { @ApiOperation('測試Swagger2') //顯示在接口的信息說明 @RequestMapping(value = '/test', method = RequestMethod.GET) //請求路徑和類型 public void testSwagger(){ }}

3、創建一個SwaggerConfig類,配置swagger-ui

package cn.swpu.myblog.config;import org.springframework.context.annotation.Configuration;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig {}

然后就可以根據你的端口訪問swagger-ui了,例如我的是8099

http://localhost:8099/swagger-ui.html#/

IDEA SpringBoot 項目配置Swagger2的詳細教程IDEA SpringBoot 項目配置Swagger2的詳細教程

至此IDEA 繼承Swagger就可以了,但這僅僅只是個開始,swagger還是有很多的實用技巧。

到此這篇關于IDEA SpringBoot 項目配置Swagger2的詳細教程的文章就介紹到這了,更多相關IDEA SpringBoot 項目配置Swagger2內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網!

標簽: Spring
相關文章:
主站蜘蛛池模板: 和政县| 平南县| 瓮安县| 新竹县| 留坝县| 徐水县| 枝江市| 乐陵市| 淄博市| 嘉兴市| 长白| 哈密市| 青阳县| 吉林市| 年辖:市辖区| 教育| 邹平县| 南充市| 太仆寺旗| 乐都县| 高雄市| 卓资县| 宁化县| 岚皋县| 阜新| 桃园市| 琼中| 前郭尔| 镇雄县| 岑巩县| 金沙县| 夹江县| 吉安县| 响水县| 武义县| 吴旗县| 永嘉县| 广南县| 黎城县| 南溪县| 双辽市|