Springboot2.7.2 整合Swagger3

1,创建一个SpringBoot 2.7.2项目
2,Jdk1.8
依赖引入
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-tomcat</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
    <!-- web依赖包-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- swagger3包-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
    </dependency>
    <!-- 引入swagger-bootstrap-ui包,优化UI页面,可不加 -->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>swagger-bootstrap-ui</artifactId>
        <version>1.9.6</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>

</dependencies>
Swagger配置
配置文件配置
server.port=8081
#true开启swagger false关闭
swagger.enabled=true
#Spring Boot 2.6.X使用的是PathPatternMatcher swagger想要正常使用需要添加
spring.mvc.pathmatch.matching-strategy=ant_path_matcher

Java配置类
package com.example.demo.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
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 zjt
 * @description: swagger
 * @date 2022-07-15 16:04:24
 */
@Configuration
@EnableOpenApi
public class SwaggerConfig {

    /**
     * application中还配置了mvc,因为springboot2.6.1与swagger3不兼容
     * ture 启用Swagger3.0, false 禁用(生产环境要禁用)
     */
    @Value("${swagger.enabled:false}")
    private Boolean swaggerEnabled;

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                // 是否开启swagger
                .enable(swaggerEnabled)
                .select()
                // 扫描的路径使用@Api的controller
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any())
                .build();
        //请求URL都会加上/project前缀
        //.pathMapping("/project");
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xxx项目接口文档")
                .description("前后端分离的接口文档")
                .version("1.0")
                .build();
    }

    /**
     * 处理跨域问题
     * 允许跨域调用的过滤器
     */
    @Bean
    public CorsFilter corsFilter() {
        CorsConfiguration config = new CorsConfiguration();
        //允许所有域名进行跨域调用
        config.addAllowedOriginPattern("*");
        //允许跨越发送cookie
        config.setAllowCredentials(true);
        //放行全部原始头信息
        config.addAllowedHeader("*");
        //允许所有请求方法跨域调用
        config.addAllowedMethod("*");
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", config);
        return new CorsFilter(source);
    }
}

测试Controller
package com.example.demo.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

/**
 * @author zjt
 * @description: swagger demo test
 * @date 2022-07-28 13:30:22
 */
@Api(tags = "测试接口")
@RestController
@Slf4j
@RequestMapping("/test")
public class TestController {

    @ApiOperation(value = "分页查询XXX信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "pageSize", value = "每页大小", dataTypeClass = Integer.class),
            @ApiImplicitParam(name = "currentPage", value = "当前页码", dataTypeClass = Integer.class)
    })
    @GetMapping(value = "/selectPageList")
    public Map<String, Object> selectPageList(@RequestParam(value = "pageSize", required = false, defaultValue = "10") Integer pageSize,
                                              @RequestParam(value = "currentPage", required = false, defaultValue = "1") Integer currentPage) {
        Map<String, Object> map = new HashMap<>();
        map.put("name","王某某");
        map.put("age",12);
        return map;
    }
}

启动访问项目
新swagger Ui界面:http://localhost:8081/doc.html
![在这里插入图片描述](https://img-blog.csdnimg.cn/78c485e7ceb4407e891faa6cb639e1f2.png#pic_center)
![在这里插入图片描述](https://img-blog.csdnimg.cn/1c890719c88e49c0bb3a6770061b340d.png#pic_center)

旧SwaggerUi界面:http://localhost:8081/swagger-ui/index.html

```借阅[处](https://blog.csdn.net/weixin_42426976/article/details/126033201?ops_request_misc=&request_id=&biz_id=102&utm_term=springboot2.7.2%E6%95%B4%E5%90%88swagger&utm_medium=distribute.pc_search_result.none-task-blog-2~all~sobaiduweb~default-0-126033201.142%5Ev42%5Epc_rank_34,185%5Ev2%5Econtrol&spm=1018.2226.3001.4187)

好的,我可以为您提供一些指导。 首先,您需要在您的Spring Boot项目中添加Spring Security和Redis的依赖。 ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> ``` 然后,在您的Spring Boot项目中创建一个配置类,该类将配置Spring Security和Redis的集成。 ```java @Configuration @EnableWebSecurity public class SecurityConfig extends WebSecurityConfigurerAdapter { @Autowired private RedisConnectionFactory redisConnectionFactory; @Override protected void configure(HttpSecurity http) throws Exception { http.authorizeRequests() .antMatchers("/admin/**").hasRole("ADMIN") .antMatchers("/user/**").hasRole("USER") .anyRequest().authenticated() .and() .formLogin() .and() .logout() .logoutSuccessUrl("/"); } @Override protected void configure(AuthenticationManagerBuilder auth) throws Exception { RedisUserDetailsService userDetailsService = new RedisUserDetailsService(redisConnectionFactory); auth.userDetailsService(userDetailsService); } @Bean public RedisTokenRepositoryImpl redisTokenRepository() { return new RedisTokenRepositoryImpl(redisConnectionFactory); } @Bean public TokenBasedRememberMeServices rememberMeServices() { TokenBasedRememberMeServices rememberMeServices = new TokenBasedRememberMeServices("remember-me", userDetailsService()); rememberMeServices.setTokenRepository(redisTokenRepository()); return rememberMeServices; } @Bean public PasswordEncoder passwordEncoder() { return new BCryptPasswordEncoder(); } } ``` 上述配置类中的configure(HttpSecurity http)方法指定了不同角色的用户可以访问哪些URL。configure(AuthenticationManagerBuilder auth)方法指定了如何从Redis中获取用户信息。redisTokenRepository()和rememberMeServices()方法指定了如何将Remember-Me令牌存储到Redis中。 最后,在您的Spring Boot项目中创建一个RedisUserDetailsService类,该类将从Redis中获取用户信息。 ```java public class RedisUserDetailsService implements UserDetailsService { private RedisConnectionFactory redisConnectionFactory; public RedisUserDetailsService(RedisConnectionFactory redisConnectionFactory) { this.redisConnectionFactory = redisConnectionFactory; } @Override public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>(); redisTemplate.setConnectionFactory(redisConnectionFactory); redisTemplate.setKeySerializer(new StringRedisSerializer()); redisTemplate.setHashKeySerializer(new StringRedisSerializer()); redisTemplate.setHashValueSerializer(new GenericToStringSerializer<>(Object.class)); redisTemplate.afterPropertiesSet(); Map<Object, Object> userMap = redisTemplate.opsForHash().entries("user:" + username); if (userMap.isEmpty()) { throw new UsernameNotFoundException("User '" + username + "' not found"); } String password = (String) userMap.get("password"); List<String> authorities = (List<String>) userMap.get("authorities"); List<GrantedAuthority> grantedAuthorities = new ArrayList<>(); for (String authority : authorities) { grantedAuthorities.add(new SimpleGrantedAuthority(authority)); } return new User(username, password, grantedAuthorities); } } ``` 上述类中的loadUserByUsername(String username)方法从Redis中获取用户信息。 希望这些信息能对您有所帮助!
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值