Springboot2 Swagger3 集成

文章目录

一、默认UI
- 1. 版本尝鲜
- 2. 导入依赖
- 3. Swagger3Config配置类
- 4. Swagger3.0常用注解
- 4.Controller 层使用Swagger3注解例子
- 5.访问Swagger3接口文档界面
- 6.Swagger3接口文档界面展示
二、bootstrapUI
- 2.1. 导入依赖
- 2.2. 访问地址

一、默认UI

1. 版本尝鲜

Swagger3在Swagger2的基础上进行了部分升级，使用和Swagger2没有多少区别。

一个重要的优化是依赖的引入，由之前的多个依赖变更为一个依赖，跟随springboot-starter风格，同时引入了新的开关注解 @EnableOpenApi 以代替@EnableSwagger2 。

因此，集成工作变得更加的简便了，必要工作只有两个，添加swagger3的starter依赖包，在springboot主程序类添加@EnableOpenApi开关注解。

2. 导入依赖

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version></dependency></dependencies>

3. Swagger3Config配置类

(必选)添加开关注解@EnableOpenApi

package com.gblfy.common.config;import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;/*** @author gblfy*/
//@EnableSwagger2 是 swagger2.0版本的注解
//swagger在3.0之后换成了@EnableOpenApi
@Configuration
@EnableOpenApi
public class SwaggerConfig {@Beanpublic Docket createRestApi(){return new Docket(DocumentationType.OAS_30).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).paths(PathSelectors.any()).build();}private ApiInfo apiInfo(){return new ApiInfoBuilder().title("Swagger3接口文档").description("适用于前后端分离统一的接口文档").version("1.0").build();}
}

4. Swagger3.0常用注解

@Api：用在请求的类上，表示对类的说明
tags=“说明该类的作用，可以在UI界面上看到的注解”
value=“该参数没什么意义，在UI界面上也看到，所以不需要配置”

@ApiOperation：用在请求的方法上，说明方法的用途、作用
value=“说明方法的用途、作用”
notes=“方法的备注说明”

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· div（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer”
defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty：用在属性上，描述响应类的属性

4.Controller 层使用Swagger3注解例子

package com.gblfy.controller;import com.infoshare.service.IUserService;
import com.infoshare.util.SendMailUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.scheduling.annotation.Async;
import javax.annotation.Resource;
import javax.servlet.http.HttpSession;/*** @author: gblfy* @time: 2021/9/17*/
@Api(tags = "用户信息处理")
@RestController
@RequestMapping("/user")
public class UserController {@Resource(name = "userServiceImpl")private IUserService userService;@Resource(name = "sendMailUtil")private SendMailUtil sendMailUtil;private final static int AUTH_CODE_VALID_TIME = 600; //验证码失效时间为 10 min/*** 异步获得验证码的接口* 验证码存储到 Session 里面* @param mail 邮箱* @return authCode_*/@ApiOperation("用户获得注册验证码")@Async@GetMapping("/getAuthCode")public String getAuthCode(@RequestParam(name = "mail") String mail,HttpSession session){String authCode_ = sendMailUtil.sendMailAndGetAuthCode(mail);session.setAttribute("mail",authCode_);session.setMaxInactiveInterval(AUTH_CODE_VALID_TIME); //设置验证码失效时间为10minreturn authCode_;}}

5.访问Swagger3接口文档界面

Swagger的访问路径由port/swagger-ui.html改成了 port/swagger-ui/ 或port/swagger-ui/index.html
两种访问方式任选其一

http://localhost:8080/swagger-ui/
http://localhost:8080/swagger-ui/index.html

6.Swagger3接口文档界面展示

二、bootstrapUI

2.1. 导入依赖

  <dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.6</version></dependency>

2.2. 访问地址

http://localhost:8080/doc.html

Springboot2 Swagger3 集成相关推荐

SpringBoot笔记：SpringBoot2.3集成SpringSession+nginx+redis实现session共享
文章目录 Spring Session介绍 Redis集成 yml配置依赖添加 redis存值查看登录服务器查看redis的值查询所有"spring:session:"开头的 ...
SpringBoot学习历程（十一）：SpringBoot2.X集成mail发送邮件
SpringBoot学习历程(十一):SpringBoot2.X集成mail发送邮件前言 1. 引入依赖 2. 设置邮件配置信息 3. 发送邮件 3.1 发送普通文本邮件 3.2 发送HTML格式内 ...
SpringBoot2.x 集成七牛云对象存储Kodo
本文主要对SpringBoot2.x集成七牛云对象存储Kodo进行简单总结,其中SpringBoot使用的2.4.5版本. 一.七牛云对象存储Kodo简介七牛云对象存储Kodo是七牛云提供的高可靠. ...
SpringBoot2.x 集成 FreeMarker
本文主要对SpringBoot2.x集成FreeMarker及其常用语法进行简单总结,其中SpringBoot使用的2.4.5版本. 一.FreeMarker简介 Apache FreeMarker™ ...
Springboot2.0集成阿里云RocketMQ
介绍 RocketMQ是出自阿里巴巴的一款开源消息中间件,在设计上借鉴了Kafka,2017年成为Apache顶级项目,虽然目前社区无法和Kafka比肩,但其历经多次天猫双十一的考验,其性能和稳定是毋 ...
springboot2.x集成ureport2.2.9搭建报表引擎
springboot2.x集成ureport2.2.9搭建报表引擎 1.创建springboot项目,修改pom.xml添加相关依赖 2.增加src/main/resources/context.pr ...
SpringBoot2.x 集成 Thymeleaf
本文主要对SpringBoot2.x集成Thymeleaf及其常用语法进行简单总结,其中SpringBoot使用的2.4.5版本. 一.Thymeleaf简介 Thymeleaf是面向Web和独立环境 ...
Springboot2.x集成ElasticSearch
目录 springboot2.x集成es springboot2.x集成es 首先导入我们的pom依赖 <dependency><groupId>org.springframe ...
SpringBoot2.x 集成 SpringDataJpa
SpringDataJpa简介:Spring Data JPA是Spring Data家族的一员,可以轻松实现基于JPA的存储库.该模块处理对基于JPA的数据访问层的增强支持.这使得构建使用数据访问技 ...