升级swagger到最新版本v3.0.0

RuoYi

2021-06-08 8722e184d6d7219645310804624aa14543615604

升级swagger到最新版本v3.0.0

 pom.xml

@@ -23,8 +23,8 @@
        <alibaba.nacos.version>2.0.1</alibaba.nacos.version>

        <spring-boot-admin.version>2.4.1</spring-boot-admin.version>

        <spring-boot.mybatis>2.1.4</spring-boot.mybatis>

        <swagger.fox.version>2.9.2</swagger.fox.version>

        <swagger.core.version>1.5.24</swagger.core.version>

        <swagger.fox.version>3.0.0</swagger.fox.version>

        <swagger.core.version>1.6.2</swagger.core.version>

        <tobato.version>1.26.5</tobato.version>

        <kaptcha.version>2.3.2</kaptcha.version>

        <pagehelper.boot.version>1.3.0</pagehelper.boot.version>


 ruoyi-common/ruoyi-common-swagger/pom.xml

@@ -16,19 +16,19 @@
    </description>



    <dependencies>

	    


        <!-- SpringBoot Web -->

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-web</artifactId>

        </dependency>

		


        <!-- Swagger -->

        <dependency>

            <groupId>io.springfox</groupId>

            <artifactId>springfox-swagger2</artifactId>

            <version>${swagger.fox.version}</version>

        </dependency>

		


    </dependencies>

</project>


 ruoyi-common/ruoyi-common-swagger/src/main/java/com/ruoyi/common/swagger/config/SwaggerAutoConfiguration.java

@@ -3,13 +3,12 @@
import java.util.ArrayList;

import java.util.Arrays;

import java.util.List;

import java.util.function.Predicate;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import com.google.common.base.Predicate;

import com.google.common.base.Predicates;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

@@ -18,8 +17,10 @@
import springfox.documentation.service.AuthorizationScope;

import springfox.documentation.service.Contact;

import springfox.documentation.service.SecurityReference;

import springfox.documentation.service.SecurityScheme;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spi.service.contexts.SecurityContext;

import springfox.documentation.spring.web.plugins.ApiSelectorBuilder;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;



@@ -60,27 +61,26 @@
        {

            swaggerProperties.getExcludePath().addAll(DEFAULT_EXCLUDE_PATH);

        }



        List<Predicate<String>> excludePath = new ArrayList<>();

        swaggerProperties.getExcludePath().forEach(path -> excludePath.add(PathSelectors.ant(path)));



        //noinspection Guava

        return new Docket(DocumentationType.SWAGGER_2)

                .host(swaggerProperties.getHost())

        ApiSelectorBuilder builder = new Docket(DocumentationType.SWAGGER_2).host(swaggerProperties.getHost())

                .apiInfo(apiInfo(swaggerProperties)).select()

                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))

                .paths(Predicates.and(Predicates.not(Predicates.or(excludePath)), Predicates.or(basePath)))

                .build()

                .securitySchemes(securitySchemes())

                .securityContexts(securityContexts())

                .pathMapping("/");

                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()));



        swaggerProperties.getBasePath().forEach(p -> builder.paths(PathSelectors.ant(p)));

        swaggerProperties.getExcludePath().forEach(p -> builder.paths(PathSelectors.ant(p).negate()));



        return builder.build().securitySchemes(securitySchemes()).securityContexts(securityContexts()).pathMapping("/");

    }



    /**

     * 安全模式，这里指定token通过Authorization头请求头传递

     */

    private List<ApiKey> securitySchemes()

    private List<SecurityScheme> securitySchemes()

    {

        List<ApiKey> apiKeyList = new ArrayList<ApiKey>();

        List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();

        apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));

        return apiKeyList;

    }

@@ -94,7 +94,7 @@
        securityContexts.add(

                SecurityContext.builder()

                        .securityReferences(defaultAuth())

                        .forPaths(PathSelectors.regex("^(?!auth).*$"))

                        .operationSelector(o -> o.requestMappingPattern().matches("/.*"))

                        .build());

        return securityContexts;

    }


 ruoyi-common/ruoyi-common-swagger/src/main/java/com/ruoyi/common/swagger/config/SwaggerWebConfiguration.java

New file
@@ -0,0 +1,22 @@
package com.ruoyi.common.swagger.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * swagger 资源映射路径
 * 
 * @author ruoyi
 */
@Configuration
public class SwaggerWebConfiguration implements WebMvcConfigurer
{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry)
    {
        /** swagger-ui 地址 */
        registry.addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/");
    }
}

 ruoyi-common/ruoyi-common-swagger/src/main/resources/META-INF/spring.factories

@@ -1,2 +1,3 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

  com.ruoyi.common.swagger.config.SwaggerAutoConfiguration

  com.ruoyi.common.swagger.config.SwaggerAutoConfiguration,\

  com.ruoyi.common.swagger.config.SwaggerWebConfiguration

 ruoyi-gateway/src/main/java/com/ruoyi/gateway/config/SwaggerProvider.java

@@ -7,6 +7,8 @@
import org.springframework.cloud.gateway.route.RouteLocator;

import org.springframework.cloud.gateway.support.NameUtils;

import org.springframework.stereotype.Component;

import org.springframework.web.reactive.config.ResourceHandlerRegistry;

import org.springframework.web.reactive.config.WebFluxConfigurer;

import springfox.documentation.swagger.web.SwaggerResource;

import springfox.documentation.swagger.web.SwaggerResourcesProvider;



@@ -16,7 +18,7 @@
 * @author ruoyi

 */

@Component

public class SwaggerProvider implements SwaggerResourcesProvider

public class SwaggerProvider implements SwaggerResourcesProvider, WebFluxConfigurer

{

    /**

     * Swagger2默认的url后缀

@@ -63,4 +65,12 @@
        swaggerResource.setSwaggerVersion("2.0");

        return swaggerResource;

    }



    @Override

    public void addResourceHandlers(ResourceHandlerRegistry registry)

    {

        /** swagger-ui 地址 */

        registry.addResourceHandler("/swagger-ui/**")

                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/");

    }

}


 sql/ry_20210608.sql

File was renamed from sql/ry_20210210.sql
@@ -161,23 +161,23 @@
insert into sys_menu values('3', '系统工具', '0', '3', 'tool',             null,   1, 0, 'M', '0', '0', '', 'tool',     'admin', sysdate(), '', null, '系统工具目录');
insert into sys_menu values('4', '若依官网', '0', '4', 'http://ruoyi.vip', null ,  0, 0, 'M', '0', '0', '', 'guide',    'admin', sysdate(), '', null, '若依官网地址');
-- 二级菜单
insert into sys_menu values('100',  '用户管理',       '1',   '1',  'user',                                'system/user/index',       1, 0, 'C', '0', '0', 'system:user:list',        'user',          'admin', sysdate(), '', null, '用户管理菜单');
insert into sys_menu values('101',  '角色管理',       '1',   '2',  'role',                                'system/role/index',       1, 0, 'C', '0', '0', 'system:role:list',        'peoples',       'admin', sysdate(), '', null, '角色管理菜单');
insert into sys_menu values('102',  '菜单管理',       '1',   '3',  'menu',                                'system/menu/index',       1, 0, 'C', '0', '0', 'system:menu:list',        'tree-table',    'admin', sysdate(), '', null, '菜单管理菜单');
insert into sys_menu values('103',  '部门管理',       '1',   '4',  'dept',                                'system/dept/index',       1, 0, 'C', '0', '0', 'system:dept:list',        'tree',          'admin', sysdate(), '', null, '部门管理菜单');
insert into sys_menu values('104',  '岗位管理',       '1',   '5',  'post',                                'system/post/index',       1, 0, 'C', '0', '0', 'system:post:list',        'post',          'admin', sysdate(), '', null, '岗位管理菜单');
insert into sys_menu values('105',  '字典管理',       '1',   '6',  'dict',                                'system/dict/index',       1, 0, 'C', '0', '0', 'system:dict:list',        'dict',          'admin', sysdate(), '', null, '字典管理菜单');
insert into sys_menu values('106',  '参数设置',       '1',   '7',  'config',                              'system/config/index',     1, 0, 'C', '0', '0', 'system:config:list',      'edit',          'admin', sysdate(), '', null, '参数设置菜单');
insert into sys_menu values('107',  '通知公告',       '1',   '9',  'notice',                              'system/notice/index',     1, 0, 'C', '0', '0', 'system:notice:list',      'message',       'admin', sysdate(), '', null, '通知公告菜单');
insert into sys_menu values('108',  '日志管理',       '1',   '10', 'log',                                 '',                        1, 0, 'M', '0', '0', '',                        'log',           'admin', sysdate(), '', null, '日志管理菜单');
insert into sys_menu values('109',  '在线用户',       '2',   '1',  'online',                              'monitor/online/index',    1, 0, 'C', '0', '0', 'monitor:online:list',     'online',        'admin', sysdate(), '', null, '在线用户菜单');
insert into sys_menu values('110',  '定时任务',       '2',   '2',  'job',                                 'monitor/job/index',       1, 0, 'C', '0', '0', 'monitor:job:list',        'job',           'admin', sysdate(), '', null, '定时任务菜单');
insert into sys_menu values('111',  'Sentinel控制台', '2',   '3',  'http://localhost:8718',                '',                       1, 0, 'C', '0', '0', 'monitor:sentinel:list',   'sentinel',      'admin', sysdate(), '', null, '流量控制菜单');
insert into sys_menu values('112',  'Nacos控制台',    '2',   '4',  'http://localhost:8848/nacos',          '',                       1, 0, 'C', '0', '0', 'monitor:nacos:list',      'nacos',         'admin', sysdate(), '', null, '服务治理菜单');
insert into sys_menu values('113',  'Admin控制台',    '2',   '5',  'http://localhost:9100/login',          '',                       1, 0, 'C', '0', '0', 'monitor:server:list',     'server',        'admin', sysdate(), '', null, '服务监控菜单');
insert into sys_menu values('114',  '表单构建',       '3',   '1',  'build',                                'tool/build/index',       1, 0, 'C', '0', '0', 'tool:build:list',         'build',         'admin', sysdate(), '', null, '表单构建菜单');
insert into sys_menu values('115',  '代码生成',       '3',   '2',  'gen',                                  'tool/gen/index',         1, 0, 'C', '0', '0', 'tool:gen:list',           'code',          'admin', sysdate(), '', null, '代码生成菜单');
insert into sys_menu values('116',  '系统接口',       '3',   '3',  'http://localhost:8080/swagger-ui.html', '',                      1, 0, 'C', '0', '0', 'tool:swagger:list',       'swagger',       'admin', sysdate(), '', null, '系统接口菜单');
insert into sys_menu values('100',  '用户管理',       '1',   '1',  'user',                                      'system/user/index',       1, 0, 'C', '0', '0', 'system:user:list',        'user',          'admin', sysdate(), '', null, '用户管理菜单');
insert into sys_menu values('101',  '角色管理',       '1',   '2',  'role',                                      'system/role/index',       1, 0, 'C', '0', '0', 'system:role:list',        'peoples',       'admin', sysdate(), '', null, '角色管理菜单');
insert into sys_menu values('102',  '菜单管理',       '1',   '3',  'menu',                                      'system/menu/index',       1, 0, 'C', '0', '0', 'system:menu:list',        'tree-table',    'admin', sysdate(), '', null, '菜单管理菜单');
insert into sys_menu values('103',  '部门管理',       '1',   '4',  'dept',                                      'system/dept/index',       1, 0, 'C', '0', '0', 'system:dept:list',        'tree',          'admin', sysdate(), '', null, '部门管理菜单');
insert into sys_menu values('104',  '岗位管理',       '1',   '5',  'post',                                      'system/post/index',       1, 0, 'C', '0', '0', 'system:post:list',        'post',          'admin', sysdate(), '', null, '岗位管理菜单');
insert into sys_menu values('105',  '字典管理',       '1',   '6',  'dict',                                      'system/dict/index',       1, 0, 'C', '0', '0', 'system:dict:list',        'dict',          'admin', sysdate(), '', null, '字典管理菜单');
insert into sys_menu values('106',  '参数设置',       '1',   '7',  'config',                                    'system/config/index',     1, 0, 'C', '0', '0', 'system:config:list',      'edit',          'admin', sysdate(), '', null, '参数设置菜单');
insert into sys_menu values('107',  '通知公告',       '1',   '9',  'notice',                                    'system/notice/index',     1, 0, 'C', '0', '0', 'system:notice:list',      'message',       'admin', sysdate(), '', null, '通知公告菜单');
insert into sys_menu values('108',  '日志管理',       '1',   '10', 'log',                                       '',                        1, 0, 'M', '0', '0', '',                        'log',           'admin', sysdate(), '', null, '日志管理菜单');
insert into sys_menu values('109',  '在线用户',       '2',   '1',  'online',                                    'monitor/online/index',    1, 0, 'C', '0', '0', 'monitor:online:list',     'online',        'admin', sysdate(), '', null, '在线用户菜单');
insert into sys_menu values('110',  '定时任务',       '2',   '2',  'job',                                       'monitor/job/index',       1, 0, 'C', '0', '0', 'monitor:job:list',        'job',           'admin', sysdate(), '', null, '定时任务菜单');
insert into sys_menu values('111',  'Sentinel控制台', '2',   '3',  'http://localhost:8718',                      '',                       1, 0, 'C', '0', '0', 'monitor:sentinel:list',   'sentinel',      'admin', sysdate(), '', null, '流量控制菜单');
insert into sys_menu values('112',  'Nacos控制台',    '2',   '4',  'http://localhost:8848/nacos',                '',                       1, 0, 'C', '0', '0', 'monitor:nacos:list',      'nacos',         'admin', sysdate(), '', null, '服务治理菜单');
insert into sys_menu values('113',  'Admin控制台',    '2',   '5',  'http://localhost:9100/login',                '',                       1, 0, 'C', '0', '0', 'monitor:server:list',     'server',        'admin', sysdate(), '', null, '服务监控菜单');
insert into sys_menu values('114',  '表单构建',       '3',   '1',  'build',                                      'tool/build/index',       1, 0, 'C', '0', '0', 'tool:build:list',         'build',         'admin', sysdate(), '', null, '表单构建菜单');
insert into sys_menu values('115',  '代码生成',       '3',   '2',  'gen',                                        'tool/gen/index',         1, 0, 'C', '0', '0', 'tool:gen:list',           'code',          'admin', sysdate(), '', null, '代码生成菜单');
insert into sys_menu values('116',  '系统接口',       '3',   '3',  'http://localhost:8080/swagger-ui/index.html', '',                      1, 0, 'C', '0', '0', 'tool:swagger:list',       'swagger',       'admin', sysdate(), '', null, '系统接口菜单');
-- 三级菜单
insert into sys_menu values('500',  '操作日志', '108', '1', 'operlog',    'system/operlog/index',     1, 0, 'C', '0', '0', 'system:operlog:list',     'form',          'admin', sysdate(), '', null, '操作日志菜单');
insert into sys_menu values('501',  '登录日志', '108', '2', 'logininfor', 'system/logininfor/index',  1, 0, 'C', '0', '0', 'system:logininfor:list',  'logininfor',    'admin', sysdate(), '', null, '登录日志菜单');