最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

SpringBoot整合Swagger3.0全過程

 更新時(shí)間:2026年03月13日 15:07:14   作者:bug攻城獅  
文章介紹了Swagger3,一個(gè)自動(dòng)生成接口文檔的工具,相比Swagger2,配置更少,使用更方便,文章詳細(xì)介紹了如何引入依賴,添加開關(guān)注解,訪問Swagger界面,以及如何配置Swagger和引入第三方UI包來美化頁面

一、引言

前后端分離的項(xiàng)目,接口文檔的存在十分重要。與手動(dòng)編寫接口文檔不同,swagger是一個(gè)自動(dòng)生成接口文檔的工具,只需要在pom文件中引入一個(gè)依賴包,然后在代碼中通過注解的方式即可實(shí)現(xiàn)文檔的編寫,畢竟在需求不斷變更的環(huán)境下,手動(dòng)編寫文檔的效率實(shí)在太低且不夠同步,swagger的出現(xiàn),將文檔和代碼融合在一起,再也不需要寫完代碼后再去手動(dòng)修改文檔了。

二、簡(jiǎn)介

Swagger3在Swagger2的基礎(chǔ)上進(jìn)行了部分升級(jí),與swagger2相比新版的swagger3配置更少,使用更加方便。

一個(gè)重要的優(yōu)化是依賴的引入,由之前的多個(gè)依賴變更為一個(gè)依賴,跟隨springboot-starter風(fēng)格,同時(shí)引入了新的開關(guān)注解 @EnableOpenApi 以代替 @EnableSwagger2 。

因此,集成工作變得更加的簡(jiǎn)便了,必要工作只有兩個(gè),添加swagger3的starter依賴包,在springboot主啟動(dòng)類添加 @EnableOpenApi 開關(guān)注解。

三、快速入門

(一)引入依賴

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

(二)主啟動(dòng)類添加開關(guān)注解 @EnableOpenApi

作用:表示開啟生成接口文檔功能,只有開啟了OpenApi,才能實(shí)現(xiàn)生成接口文檔的功能

@EnableOpenApi
@SpringBootApplication
public class SwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SwaggerApplication.class, args);
    }
}

(三)訪問Swagger界面

訪問地址(默認(rèn)端口號(hào)是8080):http://localhost:8080/swagger-ui/index.html

四、進(jìn)階使用

(一)配置Swagger

// 表明當(dāng)前類是配置類
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                // 為api選擇啟動(dòng)生成器
                .select()
                // 指定要生成api文檔的根包
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 路徑配置
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 創(chuàng)建一個(gè)ApiInfo對(duì)象
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 文檔標(biāo)題
                .title("SpringBoot整合Swagger3")
                // 簡(jiǎn)介
                .description("更多請(qǐng)咨詢服務(wù)開發(fā)者小龍")
                // 作者信息:作者姓名、作者地址、作者郵箱
                .contact(new Contact("小龍", "https://blog.csdn.net/wangzhilong1996", "123456@qq.com"))
                // 版本號(hào)
                .version("1.0")
                .build();
    }
}

(二)引入第三方UI包

原生的ui頁面并不美觀,可以使用第三方的ui包來美化頁面,當(dāng)然,市面上的第三方ui包有很多,大家可以找一個(gè)自己喜歡的,不一定用我的。

<!-- swagger 第三方ui包 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

訪問地址:http://localhost:8080/doc.html

總結(jié)

以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。

相關(guān)文章

最新評(píng)論

玉林市| 英吉沙县| 邵阳县| 陈巴尔虎旗| 梅河口市| 那曲县| 汽车| 探索| 江华| 宣汉县| 宝鸡市| 波密县| 曲麻莱县| 黄龙县| 韩城市| 怀化市| 衡水市| 永平县| 沛县| 疏附县| 蒙阴县| 隆化县| 从化市| 朝阳区| 化州市| 阿瓦提县| 吉林省| 梅州市| 宜川县| 论坛| 汝州市| 潮安县| 绿春县| 外汇| 新建县| 张家界市| 宜宾市| 盐池县| 定日县| 张家港市| 宁都县|