SpringBoot 2.2.5 整合Swagger 2.9.2，实现扫描多个不同包的接口，并配置支持传参Token进行验证

已于 2023-12-20 14:11:11 修改
阅读量1k 收藏 6
点赞数 5
分类专栏： Java 文章标签： spring boot java swagger
于 2023-12-20 10:09:30 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43659871/article/details/135101098
版权

说明

  1. 引Swagger2.9.2，主要用于生成、描述、调用和可视化RESTful风格的web服务的接口文档，方便调试本地接口使用。
  2. 完整代码地址在结尾！！

第一步，在pom.xml加入依赖，如下

<!-- web依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-spring-web</artifactId>
    <version>2.9.2</version>
</dependency>

第二步，配置application.yml，避免端口冲突

server:
  port: 8081

第三步，创建类TestRequest，TestResponse，如下

TestRequest

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * @Description:
 * @Author: jinhaoxun
 * @Date: 2020/5/14 9:30 下午
 * @Version: 1.0.0
 */
@Data
public class TestRequest {

    @ApiModelProperty(required = true, value = "用户id", example = "123")
    private String id;

    @ApiModelProperty(required = true, value = "用户name", example = "百里玄刺")
    private String name;

    @ApiModelProperty(required = true, value = "用户age", example = "18")
    private int age;

    @ApiModelProperty(required = true, value = "用户sex", example = "男")
    private String sex;

}

TestResponse

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * @Description:
 * @Author: jinhaoxun
 * @Date: 2020/5/14 9:30 下午
 * @Version: 1.0.0
 */
@ApiModel("getTest响应实体")
@Data
public class TestResponse {

    @ApiModelProperty(required = true, value = "用户id", example = "123")
    private String id;
    
    @ApiModelProperty(required = true, value = "用户name", example = "百里玄刺")
    private String name;
    
    @ApiModelProperty(required = true, value = "用户age", example = "18")
    private int age;
    
    @ApiModelProperty(required = true, value = "用户sex", example = "男")
    private String sex;

}

第四步，创建类Test1Controller，Test2Controller，Test3Controller（在接口上添加对应注解，本人只添加基本的注解），并分别放于com.luoyu.swagger.controller.test1，com.luoyu.swagger.controller.test2，com.luoyu.swagger.controller.test3包下（配置文件里面配置的扫描路径）。

Test1Controller

import com.luoyu.swagger.entity.request.TestRequest;
import com.luoyu.swagger.entity.response.TestResponse;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.beans.BeanUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author jinhaoxun
 * @since 2020-02-13
 */
@RestController
@RequestMapping("/test1")
@Api(value = "Test1Controller", tags = "Test1Controller接口")
public class Test1Controller {

    /**
     * @author jinhaoxun
     * @description 测试接口1
     */
    @ApiResponses({
            @ApiResponse(code = 200, message = "成功！"),
            @ApiResponse(code = 500, message = "服务器内部错误，请联系管理人员！"),
            @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
    })
    @PostMapping(value = "/gettest1", produces = "application/json; charset=UTF-8")
    @ApiOperation(value = "test1接口名称", notes = "test1接口描述")
    public TestResponse getTest1(TestRequest request) throws Exception {
        TestResponse response = new TestResponse();
        BeanUtils.copyProperties(request, response);
        return response;
    }

    /**
     * @author jinhaoxun
     * @description 测试接口2
     */
    @ApiResponses({
            @ApiResponse(code = 200, message = "成功！"),
            @ApiResponse(code = 500, message = "服务器内部错误，请联系管理人员！"),
            @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
    })
    @PostMapping(value = "/gettest2", produces = "application/json; charset=UTF-8")
    @ApiOperation(value = "test2接口名称", notes = "test2接口描述")
    public TestResponse getTest2(TestRequest request) throws Exception {
        TestResponse response = new TestResponse();
        BeanUtils.copyProperties(request, response);
        return response;
    }

}

Test2Controller

import com.luoyu.swagger.entity.request.TestRequest;
import com.luoyu.swagger.entity.response.TestResponse;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.beans.BeanUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author jinhaoxun
 * @since 2020-02-13
 */
@RestController
@RequestMapping("/test2")
@Api(value = "Test2Controller", tags = "Test2Controller接口")
public class Test2Controller {

    /**
     * @author jinhaoxun
     * @description 测试接口1
     */
    @ApiResponses({
            @ApiResponse(code = 200, message = "成功！"),
            @ApiResponse(code = 500, message = "服务器内部错误，请联系管理人员！"),
            @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
    })
    @PostMapping(value = "/gettest1", produces = "application/json; charset=UTF-8")
    @ApiOperation(value = "test1接口名称", notes = "test1接口描述")
    public TestResponse getTest1(TestRequest request) throws Exception {
        TestResponse response = new TestResponse();
        BeanUtils.copyProperties(request, response);
        return response;
    }

}

Test3Controller

import com.luoyu.swagger.entity.request.TestRequest;
import com.luoyu.swagger.entity.response.TestResponse;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.beans.BeanUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author jinhaoxun
 * @since 2020-02-13
 */
@RestController
@RequestMapping("/test3")
@Api(value = "Test3Controller", tags = "Test3Controller接口")
public class Test3Controller {

    /**
     * @author jinhaoxun
     * @description 测试接口1
     */
    @ApiResponses({
            @ApiResponse(code = 200, message = "成功！"),
            @ApiResponse(code = 500, message = "服务器内部错误，请联系管理人员！"),
            @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
    })
    @PostMapping(value = "/gettest1", produces = "application/json; charset=UTF-8")
    @ApiOperation(value = "test1接口名称", notes = "test1接口描述")
    public TestResponse getTest1(TestRequest request) throws Exception {
        TestResponse response = new TestResponse();
        BeanUtils.copyProperties(request, response);
        return response;
    }

}

第五步，创建Swagger2Config配置文件，如下

import com.google.common.base.Function;
import com.google.common.base.Predicate;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

/**
 * @version 1.0
 * @author jinhaoxun
 * @date 2019-08-09
 * @description Swagger配置
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 定义分隔符
     */
    private static final String SPLITOR = ";";

    /**
     * @author jinhaoxun
     * @description 配置token，以及设置扫描包的路径
     * @return Docket
     */
    @Bean("createRestApi1")
    public Docket createRestApi1() {
        //设置header里面的token
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("token").description("token令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .globalOperationParameters(pars)
                .apiInfo(apiInfo())
                .groupName("1.0.0 版本")
                .select()
                //此处添加需要扫描接口的包路径
                .apis(basePackage("com.luoyu.swagger.controller.test1" + SPLITOR
                        + "com.luoyu.swagger.controller.test2" + SPLITOR ))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * @author jinhaoxun
     * @description 配置token，以及设置扫描包的路径
     * @return Docket
     */
    @Bean("createRestApi2")
    public Docket createRestApi2() {
        //设置header里面的token
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .globalOperationParameters(pars)
                .apiInfo(apiInfo())
                .groupName("2.0.0 版本")
                .select()
                //此处添加需要扫描接口的包路径
                .apis(basePackage("com.luoyu.swagger.controller.test3" + SPLITOR ))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * @author jinhaoxun
     * @description 配置Swagger2页面显示内容
     * @return Docket
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger 接口文档")
                .description("Swagger 接口文档")
                .version("1.0.0")
                .termsOfServiceUrl("http://localhost:8081/swagger-ui.html")
                .contact("luoyu")
                .build();
    }

    /**
     * @author jinhaoxun
     * @description 重写basePackage方法，使能够实现多包访问
     * @param basePackage 所有包路径
     * @return Predicate<RequestHandler>
     */
    public static Predicate<RequestHandler> basePackage(final String basePackage) {
        return input -> declaringClass(input).map(handlerPackage(basePackage)::apply).orElse(true);
    }

    /**
     * @author jinhaoxun
     * @description 重写basePackage方法，使能够实现多包访问
     * @param basePackage 所有包路径
     * @return Function<Class<?>, Boolean>
     */
    private static Function<Class<?>, Boolean> handlerPackage(final String basePackage)     {
        return input -> {
            // 循环判断匹配
            for (String strPackage : basePackage.split(SPLITOR)) {
                assert input != null;
                boolean isMatch = input.getPackage().getName().startsWith(strPackage);
                if (isMatch) {
                    return true;
                }
            }
            return false;
        };
    }

    /**
     * @author jinhaoxun
     * @description 重写basePackage方法，使能够实现多包访问
     * @param input
     * @return Optional<? extends Class<?>>
     */
    private static Optional<Class<?>> declaringClass(RequestHandler input) {
        return Optional.ofNullable(input.declaringClass());
    }

}

说明：

  1. @Configuration 标识这是一个配置类
  2. @EnableSwagger2 开启swagger2

第六步，启动项目，访问：http://localhost:8081/swagger-ui.html，端口号根据配置文件application.yml里面的端口号进行修改，使用结果如下图

image.png

另外，此处提供一些常用注解。如下

@Api() 用于类；表示标识这个类是swagger的资源 
tags–表示说明 
value–也是说明，可以使用tags替代 

@ApiOperation() 用于方法；表示一个http请求的操作 
value用于方法描述 
notes用于提示内容 

@ApiParam() 用于方法，参数，字段说明；表示对参数的添加元数据（说明或是否必填等） 
name–参数名 
value–参数说明 
required–是否必填

@ApiModel()用于类 ；表示对类进行说明，用于参数用实体类接收 
value–表示对象名 

@ApiModelProperty()用于方法，字段； 表示对model属性的说明或者数据操作更改 
value–字段说明 
name–重写属性名字 
dataType–重写属性类型 
required–是否必填 
example–举例说明 
hidden–隐藏

@ApiImplicitParam() 用于方法 
表示单独的请求参数

@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam 
name–参数ming 
value–参数说明 
dataType–数据类型 
paramType–参数类型 
example–举例说明

@ApiIgnore
作用于方法上，使用这个注解swagger将忽略这个接口

完整代码地址：https://github.com/Jinhx128/springboot-demo

注：此工程包含多个module，本文所用代码均在swagger-demo模块下

天不生我小金
关注
  • 5
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger多个包扫描支持
流沙QuickSand
09-21 893
swagger多个包扫描支持 Docket.apis(com.google.common.base.Predicate selector)的selector。需引入Google Guava依赖。Swagger一般包含。
Swagger2配置多个扫描包路径
我有一枚大大大太阳
03-04 2894
下面是具体代码： @Configuration @EnableSwagger2 public class SwaggerConfigure { //配置swagger中Docket的bean实例 @Bean public Docket docket(Environment environment){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo...
swagger ui 添加右上角Authorization或token
最新发布
a623397674的专栏
05-29 779
title( name + "接口文档"+"("+updateTime+")")* 增加如下配置可解决Spring Boot 6.x 与Swagger 3.0.0 不兼容问题。// 设置要显示swagger的环境。
swagger多包扫描
qq_41148693的博客
03-10 3710
swagger多包扫描 在项目中swagger的接口文档使用的还是很方便的，swagger有很多中扫描接口的方式，可以自行的配置 但是swagger配置通过包扫描的方式时，而当我们想要扫描多个包的时候，就发现，swagger给的api当中只有一个string参数，就很不方便 所以自行寻找了一些配置多包扫描的方式 import com.google.common.base.Function; import com.google.common.base.Optional; import org.springfr
Swagger：swagger扫描不同包的controller
Jcsim~
10-31 4890
一、错误方法，使用 io.renren.modules.*.controller public Docket createRestApi() { log.info("======================== 当前环境是否开启Swagger：" + SwaggerSwitch + " ========================"); return new Docket(DocumentationType.SWAGGER_2) .
Swagger 多包扫描 全包扫描 极简配置
weixin_43074462的博客
06-13 941
我看网上各种自定义分隔符，又是重写方法的，说实在的太麻烦了。 个人有代码洁癖，接受不了引几个不认识的jar包就为了实现这么个小功能 网上的大神们真的是喜欢把简单的问题复杂化啊 @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()
jeecg-boot中swagger实现多个包的扫描
Yin+的专栏
12-11 1723
jeecg-boot swagger 多个包路径 自定义包 自动扫描
swagger3.0设置分组和配置多个扫描路径和过滤URL
u010797364的博客
10-26 2076
【代码】swagger3.0设置分组和配置多个扫描路径和过滤URL。
springboot2+mybatis多种方式实现多数据配置方法
08-19
SpringBoot 2.x 与 MyBatis 多种方式实现多数据配置方法 ...SpringBoot 2.x 与 MyBatis 多种方式实现多数据配置方法可以满足不同的业务需求，开发者可以根据需要选择合适的方法来实现多数据配置。
glibc库(包包括多个版本)
03-30
2. **glibc-2.3.2**: 这个版本是在2003年发布的，相较于2.2.5，它在性能和稳定性上有所提升，同时增加了一些新的函数和接口，如POSIX定时器的支持。 3. **glibc-2.7**: 发布于2008年，这个版本引入了更多的标准兼容...
idea配置springboot热部署终极解决办法(解决热部署失效问题)
08-18
idea配置springboot热部署终极解决办法是指在IDEA中配置SpringBoot项目以实现热部署的终极解决办法。热部署是指在不停止服务器的情况下，直接更新类文件并重新加载的过程。以下是实现idea配置springboot热部署的步骤...
springboot-demo:基于SpringBoot 2.x整合各种常用开发工具，包括但不限于Redis，MyBatisPlus，RocketMQ，RabbitMQ，Elasticsearch，Quartz，Xxl-Job，Kafka等
05-04
参考教程序号文章标题000102030405060708091011121314SpringBoot 2.2.5 整合Knife4j，实现扫描多个不同包的接口，并配置支持传Token进行验证以及安全认证机制15SpringBoot 2.2.5 使用Undertow替换内置Tomcat提高性能...
webwork-2.2.5源码包下载.txt
07-17
### WebWork-2.2.5源码包下载与解析 #### 一、WebWork框架简介 WebWork是一个开源的Java Web应用开发框架，它基于Java Servlet API，并且支持多种编程模型，包括MVC（Model-View-Controller）模式。WebWork框架的...
SpringBoot集成Swagger2并配置多个包路径扫描
C3Stones
11-18 5512
1. 简介   随着现在主流的前后端分离模式开发越来越成熟，接口文档的编写和规范是一件非常重要的事。简单的项目来说，对应的controller在一个包路径下，因此在Swagger配置参数时只需要配置一个包路径即可。但是对于复杂的项目，往往需要分模块开发，因此对应的controller包存在多个，所以需要在Swagger配置参数时需要指定多个包路径扫描。   在一些普遍情况下，分模块开发时...
Swagger 配置多个接口文档实现 和 实现多包扫描的配置方式
梦若辰宇的博客
09-01 3079
swagger配置多个接口文档 swagger实现多包扫描
swagger添加头部参数
小灰~的博客
09-11 2249
本例头部信息为token权限，当然使用其他的参数原理相同 1.代码截图 2.使用代码 @ApiImplicitParam(value = "鉴权token",name = "token",paramType = "header", dataType = "String", required=true) 3.swagger文档说明截图显示 4.swagger文...
swagger2 携带多个请求头
大仝小韩
08-20 3826
有看到网上文章说当header需要多个参数的时候，新建多个 ParameterBuilder，经过测试，重复使用一个ParameterBuilder会出现后面覆盖前面的情况。 我没有出现这种情况，以下是SwaggerConfig 的代码，以及效果图。 @Configuration @EnableSwagger2 public class SwaggerConfig { @Value("$...
swagger2配置扫多个包
博客
03-18 3584
简单记录下，网上搜到几个都比较麻烦 @Bean(value = "defaultApi2") public Docket defaultApi2() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() //此包路径下的类，才生成接口文档 .apis(R
springboot2.2.5 整合 es
08-20
你好！对于Spring Boot 2.2.5与Elasticsearch的整合，你可以按照以下步骤进行操作： 1. 在pom.xml文件中添加Elasticsearch的依赖： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-elasticsearch</artifactId> </dependency> ``` 2. 创建一个Elasticsearch的配置类，比如ElasticsearchConfig.java： ```java import org.elasticsearch.client.RestHighLevelClient; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.elasticsearch.client.ClientConfiguration; import org.springframework.data.elasticsearch.client.RestClients; import org.springframework.data.elasticsearch.config.AbstractElasticsearchConfiguration; @Configuration public class ElasticsearchConfig extends AbstractElasticsearchConfiguration { @Value("${elasticsearch.host}") private String host; @Value("${elasticsearch.port}") private int port; @Override @Bean public RestHighLevelClient elasticsearchClient() { final ClientConfiguration clientConfiguration = ClientConfiguration.builder() .connectedTo(host + ":" + port) .build(); return RestClients.create(clientConfiguration).rest(); } } ``` 3. 在应用的配置文件（如application.properties或a
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值