【SpringBoot】18、整合Swagger 3.0【狂神篇】

已于 2022-02-05 09:40:04 修改
阅读量2.1k 收藏 12
点赞数 2
分类专栏： # SpringBoot 文章标签： spring boot java intellij-idea
于 2022-01-24 13:17:49 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tu_wer/article/details/122665499
版权

丝袜哥

1、Swagger简介

  • Restful Api 文档在线自动生成器

    API 文档 与API 定义同步更新

    不再需要手工写API文档

  • 直接运行，在线测试API

2、集成Swagger

SpringBoot 集成 Swagger 3.0.0

与 Swagger2.x.x 是有区别的

1）新建web项目

在这里插入图片描述

2）pom.xml 引入启动器

Swagger 3.0.0 只需要引入启动器 springfox-boot-starter

Swagger 2.x.x 需要引入两个jar包 springfox-swagger2 和springfox-swagger-ui

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

3）配置类SwaggerConfig

@EnableWebMvc 也可以加在入口程序上

Swagger2.x.x 中使用 @EnableSwagger2

@Configuration
@EnableWebMvc
public class SwaggerConfig {

}

4）测试

在这里插入图片描述

Swagger 3.0 访问地址：http://.../swagger-ui/index.html

2.x.x 中是：http://.../swagger-ui.html

3、配置Swagger

Swagger实例Bean是Docket，通过配置Docket实例来配置Swaggger

在 SwaggerConfig 中添加

/**
* 配置Swagger具体参数
* @return
*/
@Bean
public Docket docket(){
    return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo());
}

/**
* 自定义API文档信息
* @return
*/
private ApiInfo apiInfo(){
    // 作者信息
    Contact contact = new Contact("土味儿", "http://localhost:8080/", "2141421414@qq.com");

    return new ApiInfo(
        "Hello Swagger API 文档",
        "大道无垠 行者无疆",
        "v1.0",
        "http://localhost:8080/",
        contact,
        "Apache 2.0",
        "http://www.apache.org/licenses/LICENSE-2.0",
        new ArrayList());
}

在这里插入图片描述

4、配置扫描接口

@Bean
public Docket docket(){
    return new Docket(DocumentationType.OAS_30)
        .apiInfo(apiInfo())
        // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .select()
        // 只扫描特定包下的接口
        .apis(RequestHandlerSelectors.basePackage("com.tuwer.controller"))
        .build();
}

在这里插入图片描述

  • 扫描方式

    .select().apis(RequestHandlerSelectors.xxx).build()

在这里插入图片描述

@Bean
public Docket docket(){
    return new Docket(DocumentationType.OAS_30)
        .apiInfo(apiInfo())
        // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .select()
        // 只扫描特定包下的接口
        //.apis(RequestHandlerSelectors.basePackage("com.tuwer.controller"))
        //.apis(RequestHandlerSelectors.any())
        //.apis(RequestHandlerSelectors.none())
        //.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
        .apis(RequestHandlerSelectors.withMethodAnnotation(GetMapping.class))
        .build();
}

  • 配置接口扫描过滤

    .paths(PathSelectors.ant("/hello/**"))

@Bean
public Docket docket(){
    return new Docket(DocumentationType.OAS_30)
        .apiInfo(apiInfo())
        // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .select()
        // 只扫描特定包下的接口
        //.apis(RequestHandlerSelectors.basePackage("com.tuwer.controller"))
        //.apis(RequestHandlerSelectors.any())
        //.apis(RequestHandlerSelectors.none())
        //.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
        .apis(RequestHandlerSelectors.withMethodAnnotation(GetMapping.class))
        // 只扫描请求以/hello开头的接口
        .paths(PathSelectors.ant("/hello/**"))
        .build();
}

在这里插入图片描述

5、配置Swagger开关

enable(boolean externallyConfiguredFlag)

是否启用swagger，如果是false，swagger将不能在浏览器中访问了

@Bean
public Docket docket(){
    return new Docket(DocumentationType.OAS_30)
        //.apiInfo(apiInfo())
        .enable(true)
        // ...
        .build();
}
  • 根据项目环境决定是否启用Swagger

如：开发dev、测试test 环境下启用，生产production 环境下不启用

多环境 application.yml

# 选择要激活的环境
spring:
  profiles:
    active: prod

---
# 生产环境
server:
  port: 8080
spring:
  config:
    active:
      on-profile: prod

---
# 开发环境
server:
  port: 8081
spring:
  config:
    activate:
      on-profile: dev

---
# 测试环境
server:
  port: 8082
spring:
  config:
    activate:
      on-profile: test

自动判断是否启用Swagger

@Bean
public Docket docket(Environment environment){
    // 允许启用Swagger的环境
    Profiles profile = Profiles.of("dev","test");
    // 判断当前环境与指定环境是否一致
    boolean b = environment.acceptsProfiles(profile);

    return new Docket(DocumentationType.OAS_30)
        .apiInfo(apiInfo())
        // 根据当前环境判断是否启用Swagger
        .enable(b)
        // ...
        .build();
}

在这里插入图片描述

在这里插入图片描述

6、配置API分组

groupName()

默认为 default

@Bean
public Docket docket(){
    return new Docket(DocumentationType.OAS_30).groupName("A");
}

在这里插入图片描述

  • 配置方法分组

    只需要定义多个 Docket docket() 方法

@Bean
public Docket docket(){
    return new Docket(DocumentationType.OAS_30).groupName("A");
}

@Bean
public Docket docket1(){
    return new Docket(DocumentationType.OAS_30).groupName("B");
}

@Bean
public Docket docket2(){
    return new Docket(DocumentationType.OAS_30).groupName("C");
}

@Bean
public Docket docket3(){
    return new Docket(DocumentationType.OAS_30).groupName("D");
}

在这里插入图片描述

7、实体配置

1）新建实体

@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "用户类",description = "用户实体")
public class User {
    @ApiModelProperty(value = "用户名",example = "如：张三")
    private String name;
    @ApiModelProperty(value = "用户密码;字母、数字、下划线，至少6位")
    private String ps;
}

导入 lombok

2）Controller

@GetMapping("/getUser")
public User getUser(){
    return new User();
}

3）测试

在这里插入图片描述

注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而 @ApiModel 和 @ApiModelProperty 这两个注解只是为实体添加注释的。

@ApiModel 为类添加注释

@ApiModelProperty 为类属性添加注释

8、常用注解

Swagger注解简单说明
@Api(tags = “xxx模块说明”)作用在模块类上
@ApiOperation(“xxx接口说明”)作用在接口方法上
@ApiModel(“xxxPOJO说明”)作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)作用在参数、方法和字段上，类似@ApiModelProperty
Springboot3 配置Swagger3.0版本
梦想的追求
11-07 1114
Springboot3 配置Swargger3.0版本
springboot 2.7 整合swagger3.0(knife4j)
qq_23327559的博客
07-06 2640
配置 springfoxHandlerProviderBeanPostProcessor 解决上面报错问题。4,启动项目,访问地址:ip:port/doc.html。production: true #开启生产环境屏蔽。enable: true #开启增强配置。因为版本问题会出现异常导出启动失败。basic: #基本的登录认证。3,springboot 配置。springboot 版本。
SpringBoot整合Swagger3.0
qq_51569224的博客
07-18 2837
SpringBoot整合Swagger3.0
SpringBoot集成Swagger3.0
weixin_45817985的博客
03-06 1709
SpringBoot集成Swagger3.0
SpringBoot3整合Swagger
最新发布
weixin_41863745的博客
03-24 759
之前一直使用SpringBoot2与Swagger2，所以感觉都很顺利，因网上资源也比较多问题不大。但是自从更新idea2024、jdk17之后，很多依赖都是比较新的版本，之前的很多东西需要去适应新版本就会出现很多bug，网上的很多办法不好用，只好在改好bug之后记录一下，以便大家一起学习。提示Springdoc-OpenAPI 使用教程-CSDN博客。
SpringBoot之Swagger
The_Beacon的博客
10-15 403
Swagger 了解Swagger的概念及作用 了解前后端分离 在springboot中集成swagger Swagger简介 前后端分离 Vue+SpringBoot 后端时代：前端只用管理静态页面；html==>后端。模板引擎JSP=>后端才是主力 前后端分离时代 前端 -> 前端控制层、视图层 伪造后端数据，json。已经存在了，不需要后端，前端工程队依旧能够跑起来 后端 -> 后端控制层、服务层、数据访问层 前后端通过API进行交互 前后端相对独立且松耦合 产生
springboot配置swagger3.0.0
hyprintf的博客
03-27 993
swagger2.0.0以后版本访问地址。
springboot集成swagger3.0
qq_35705176的博客
11-29 3071
springboot集成swagger3.0，解决请求参数为空问题
1、SpringBoot快速整合Swagger3.0
cchqlh的博客
01-26 2366
Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件；Swagger的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。
springboot3整合swagger3.0之knife4j-openapi3
施小楠的博客
10-09 1865
markdown文件路径,可以是一个文件夹(classpath:markdowns/*)，也可以是单个文件(classpath:md/sign.md)针对RequestMapping的接口请求类型,在不指定参数类型的情况下,如果不过滤,默认会显示7个类型的接口地址参数,是否开启界面中对某接口的版本控制,如果开启，后端变化后Ui界面会存在小蓝点。是否开启一个默认的跨域配置,该功能配合自定义Host使用。调试Tab是否显示AfterScript功能,默认开启。类似于接口中的tag,对于自定义文档的分组。
SpringBoot 整合 Swagger 3.0
QQ26843500的博客
03-19 318
/</</</
springmvc springboot集成swagger2配置实现
活跃的技术客
08-25 249
一、首先需要引用swagger2的包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <gr
Swagger3.0.0
weixin_45365220的博客
03-31 2311
作为一个RESTful风格的可视化框架，经常会和yapi作个比较， 相比于yapi其优势展现在： 自动实时更新接口信息 更强大的接口信息描述注解 劣势在于： 代码侵入性强 UI不如Yapi好看（当然swagger的UI页面支持引入更换，且swagger3的UI比以往版本好看一些） Yapi还有权限管理、团队协作、自动化测试等功能 Swagger3目前已经将注解规范化，基于openApi3，且兼容以往版本的注解和配置 今天我们来看看简单的Swagger3版本整合到springboot项目中 pom依赖
Swagger3.0.0(springboot3.2.0)
zip7986的博客
12-19 2897
Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。它是一个开源的框架，提供了完整的解决方案，用于构建、设计、文档和调用RESTful Web服务。Swagger可以让开发人员快速创建API文档，并支持自动生成客户端和服务端代码。它还提供了强大的功能，如API的发现、定义、测试和可视化等。Swagger通过注解来自动生成API文档，使得开发人员可以专注于编写代码，而不需要手动编写大量的文档。
springboot整合swagger3.0
听钱塘信来的博客
10-14 3743
springboot整合swagger
spring boot 集成Swagger
大哥一声吼
05-26 405
添加pom 依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency&gt
Swagger3.0介绍及springboot整合Swagger3.0
热门推荐
Mr.zhao的博客
04-19 1万+
Swagger 学习目标： 了解Swagger的作用和概念 了解前后端分离 在SpringBoot中集成Swagger Swagger出现的原因 前后端分离 Vue+SpringBoot 后端时代：前端只用管理静态页面;html==>后端。模板引擎 JSP=>后端是主力 前后端分离时代： 后端：后端控制层，服务层，数据访问层 【后端团队】 前端：前端控制层，视图层 【前端团队】 伪造后端数据，json。已经存在了，不需要后端，前端工程依|旧能够跑起来·前端后如何交互?===>API
Swagger 笔记
qq_36733713的博客
04-30 449
Swagger 笔记 了解Swagger的概念及作用 掌握在项目中集成Swagger自动生成API文档 Swagger简介 前后端分离 前端 -> 前端控制层data、视图层 后端 -> 后端控制层、服务层、数据访问层 前后端通过API进行交互 前后端相对独立且松耦合（可部署在不同服务器） 产生一个问题： 前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集...
Spring Boot 3.0整合SwaggerUI：真香警告！开发效率提升100%的API文档神器
2301_81186831的博客
02-24 879
自动化API文档生成零配置的接口测试平台完善的权限管理集成多环境适配方案升级建议：随着Spring Boot 3.x的普及，建议所有新项目直接采用springdoc-openapi方案。对于存量项目，迁移成本极低，只需替换依赖和少量注解调整即可。更多高级用法参考官方文档：https://springdoc.org/彩蛋：尝试在SwaggerUI的filter栏输入curl，即可获取当前请求的cURL命令！🎉。
springboot2.6整合swagger3.0
08-25
你好！要将Spring Boot 2.6与Swagger 3.0整合在一起，你可以按照以下步骤进行操作： 步骤1：添加Swagger依赖 在你的Spring Boot项目的pom.xml文件中，添加Swagger的依赖： ```xml <dependencies> <!-- 其他依赖 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> </dependencies> ``` 步骤2：配置Swagger 创建一个Swagger配置类，用于配置Swagger的相关信息： ```java import org.springframework.context.annotation.Configuration; import springfox.documentation.swagger2.annotations.EnableSwagger2; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; @Configuration @EnableSwagger2 public class SwaggerConfig { public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API 文档") .description("API 文档") .version("1.0.0") .build(); } } ``` 步骤3：启用Swagger 在你的Spring Boot应用程序的主类上使用`@EnableSwagger2`注解来启用Swagger： ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.Import; @SpringBootApplication @Import(SwaggerConfig.class) public class YourApplication { public static void main(String[] args) { SpringApplication.run(YourApplication.class, args); } } ``` 步骤4：访问Swagger UI 在启动你的应用程序后，你可以通过访问`http://localhost:8080/swagger-ui/`来查看生成的API文档。 以上就是将Spring Boot 2.6与Swagger 3.0整合的基本步骤。你可以根据自己的需要进一步定制和配置Swagger。希望能对你有所帮助！如果有任何其他问题，请随时提问。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

土味儿~

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值