Swagger接入OAuth2认证

最新推荐文章于 2024-05-13 03:21:05 发布
最新推荐文章于 2024-05-13 03:21:05 发布
阅读量3.3k 收藏 4
点赞数 1
分类专栏： java 微服务 文章标签： spring cloud
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42383970/article/details/121475856
版权

1.pom依赖

在所要使用Swagger的项目引用Swagger依赖

<dependencies>
    <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>
</dependencies>

2.Swagger配置类

该配置类上使用@EnableSwagger2标注，表示开启Swagger功能

package cc.mrbird.febs.server.system.configure;

import cc.mrbird.febs.server.system.properties.FebsServerSystemProperties;
import cc.mrbird.febs.server.system.properties.FebsSwaggerProperties;
import com.baomidou.mybatisplus.core.parser.ISqlParser;
import com.baomidou.mybatisplus.extension.parsers.BlockAttackSqlParser;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.OAuthBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.Contact;
import springfox.documentation.service.GrantType;
import springfox.documentation.service.ResourceOwnerPasswordCredentialsGrant;
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.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * @description:
 * @Author ztt
 * @create: 2021-10-24 15:09
 */
@Configuration
@EnableSwagger2
public class FebsWebConfigure {
    
    @Autowired
    private FebsServerSystemProperties properties;
    
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        List<ISqlParser> sqlParserList = new ArrayList<>();
        sqlParserList.add(new BlockAttackSqlParser());
        paginationInterceptor.setSqlParserList(sqlParserList);
        return paginationInterceptor;
    }
    /**
     * 主要是这个方法，其他的方法是抽出去的
     * 在 basePackage 里面写需要生成文档的 controller 路径
     */
    @Bean
    public Docket swaggerApi() {
        FebsSwaggerProperties swagger = properties.getSwagger();
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage(swagger.getBasePackage()))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo(swagger))
    }
    /**
     * 这个方法主要是写一些文档的描述
     */
    private ApiInfo apiInfo(FebsSwaggerProperties swagger) {
        return new ApiInfo(
                swagger.getTitle(),
                swagger.getDescription(),
                swagger.getVersion(),
                null,
                new Contact(swagger.getAuthor(), swagger.getUrl(), swagger.getEmail()),
                swagger.getLicense(), swagger.getLicenseUrl(), Collections.emptyList());
    }
}

swaggerApi方法的apis(RequestHandlerSelectors.basePackage(swagger.getBasePackage()

))表示将cc.mrbird.febs.server.system.controller路径下的所有Controller都添加进去，paths(PathSelectors.any())表示Controller里的所有方法都纳入。

apiInfo用于定义一些API页面信息，比如作者名称，邮箱，网站链接，开源协议等等。

这里固定配置较多（阿里编程规范称为“魔法值”），我们可以将它抽取为一个配置文件。在febs-system模块的cc.mrbird.febs.server.system路径下新建properties包，然后在该包下新建FebsSwaggerProperties配置文件类：

@Data
public class FebsSwaggerProperties{
    
    private String basePackage;
    private String title;
    private String description;
    private String version;
    private String author;
    private String url;
    private String email;
    private String license;
    private String licenseUrl;
    
    private String grantUrl;
    private String name;
    private String scope;
    
}
@Data
@SpringBootConfiguration
@PropertySource(value = {"classpath:febs-server-system.properties"})
@ConfigurationProperties(prefix = "febs.server.system")
public class FebsServerSystemProperties {
    /**
     * 免认证 URI，多个值的话以逗号分隔
     */
    private String anonUrl;
    
    private FebsSwaggerProperties swagger = new FebsSwaggerProperties();
}

然后在febs-server-system.properties配置文件的免认证路径里添加swagger相关资源配置：

重启febs-server-system模块，访问 http://localhost:8301/system/swagger-ui.html

105.png

3.认证oauth2

虽然已经成功接入了Swagger，但是因为我们的资源都是受资源服务器保护的，所以Swagger并不能进行正常的接口测试。所以要进行oauth2的认证

在febs-auth模块里配置一个新的Client，专门用于Swagger令牌发放。在febs-auth模块的febs-auth.properties配置文件里添加如下配置:

febs.auth.clients[1].client=swagger
febs.auth.clients[1].secret=123456
febs.auth.clients[1].grantType=password
febs.auth.clients[1].scope=test

 修改Swagger的配置类

package cc.mrbird.febs.server.system.configure;

import cc.mrbird.febs.server.system.properties.FebsServerSystemProperties;
import cc.mrbird.febs.server.system.properties.FebsSwaggerProperties;
import com.baomidou.mybatisplus.core.parser.ISqlParser;
import com.baomidou.mybatisplus.extension.parsers.BlockAttackSqlParser;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.OAuthBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.Contact;
import springfox.documentation.service.GrantType;
import springfox.documentation.service.ResourceOwnerPasswordCredentialsGrant;
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.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * @description:
 * @Author ztt
 * @create: 2021-10-24 15:09
 */
@Configuration
@EnableSwagger2
public class FebsWebConfigure {
    
    @Autowired
    private FebsServerSystemProperties properties;
    
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        List<ISqlParser> sqlParserList = new ArrayList<>();
        sqlParserList.add(new BlockAttackSqlParser());
        paginationInterceptor.setSqlParserList(sqlParserList);
        return paginationInterceptor;
    }
    /**
     * 主要是这个方法，其他的方法是抽出去的
     * 在 basePackage 里面写需要生成文档的 controller 路径
     */
    @Bean
    public Docket swaggerApi() {
        FebsSwaggerProperties swagger = properties.getSwagger();
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage(swagger.getBasePackage()))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo(swagger))
                .securitySchemes(Collections.singletonList(securityScheme(swagger)))
                .securityContexts(Collections.singletonList(securityContext(swagger)));
    }
    /**
     * 这个方法主要是写一些文档的描述
     */
    private ApiInfo apiInfo(FebsSwaggerProperties swagger) {
        return new ApiInfo(
                swagger.getTitle(),
                swagger.getDescription(),
                swagger.getVersion(),
                null,
                new Contact(swagger.getAuthor(), swagger.getUrl(), swagger.getEmail()),
                swagger.getLicense(), swagger.getLicenseUrl(), Collections.emptyList());
    }
    /**
     * 用于配置安全策略，比如配置认证模型，scope等内容
     */
    private SecurityScheme securityScheme(FebsSwaggerProperties swagger) {
        GrantType grantType = new ResourceOwnerPasswordCredentialsGrant(swagger.getGrantUrl());
        
        return new OAuthBuilder()
                .name(swagger.getName())
                .grantTypes(Collections.singletonList(grantType))
                .scopes(Arrays.asList(scopes(swagger)))
                .build();
    }
    /**
     * 这里设置 swagger2 认证的安全上下文
     */
    private SecurityContext securityContext(FebsSwaggerProperties swagger) {
        return SecurityContext.builder()
                .securityReferences(Collections.singletonList(new SecurityReference(swagger.getName(), scopes(swagger))))
                .forPaths(PathSelectors.any())
                .build();
    }
    /**
     * 这里是写允许认证的scope
     */
    private AuthorizationScope[] scopes(FebsSwaggerProperties swagger) {
        return new AuthorizationScope[]{
                new AuthorizationScope(swagger.getScope(), "")
        };
    }
}

 通过Docket的securitySchemes和securityContexts方法设置了安全策略和安全上下文。

在securityScheme方法中，我们通过OAuthBuilder对象构建了安全策略，主要配置了认证类型为ResourceOwnerPasswordCredentialsGrant（即密码模式），认证地址为http://localhost:8301/auth/oauth/token（即通过网关转发到认证服务器），scope为test，和febs-auth模块里定义的一致。这个安全策略我们将其命名为febs_oauth_swagger。

在securityContext方法中，我们通过febs_oauth_swagger名称关联了上面定义的安全策略，并且通过forPaths(PathSelectors.any())设置所有API接口都用这个安全上下文。

重启服务，重新访问Swagger服务：

 会有一个认证的按钮，点击进行认证

501.png

 认证成功之后，即可正常进行接口测试了。

即将头秃的程序媛
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
专栏目录
Springboot Oauth2 集成Swagger2权限验证实战
entfrm的博客
04-22 1882
Swagger是什么？能干什么？在这就不展开讲解了。本文主要讲解如何集成OAuth2的Password模式权限验证，验证接口是否具有权限。 引入依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactI...
Swagger(weblogic服务启动)
04-26
此外，为了确保API的安全性，可能还需要配置安全控制，如OAuth2认证或其他授权机制。 总的来说，Swagger在WebLogic服务启动中的应用，使得API的管理和开发变得更加高效和直观。通过提供清晰的API定义和交互式测试...
SpringBoot集成Swagger2登录功能和安全认证_swagger 设置登录验证
最新发布
2401_84968812的博客
05-13 644
创建拦截器 SwaggerInterceptor。新建 Swagger2Config。
swagger与oauth的集成使用
ZHBR_F1的博客
12-10 4035
1.Swagger定义 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 个人觉得，swagger的一个最大的优点是能实时同步api与文档。在项目开发过程中，发生过多次：修改代码但是没有更新文档，前端还是按照...
Swagger统一Authorization认证
百世经纶『一页書』
01-31 1440
Swagger统一Authorization认证
swagger2-身份认证Authenticatio（一）BasicAuth
热门推荐
lanwp5302的博客
09-28 1万+
这里使用spring boot 2.1.8 一、引入maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> &lt...
Swagger整合Oauth2
飘渺Jam的博客
03-08 5173
Swagger整合Oauth2
配置swagger2默认认证行为
weixin_43493520的博客
10-19 4790
swagger认证简述 swagger提供了多种认证方式，可以在swagger-ui界面上配置使用，比如：basicAuth，apiKey，oauth等 使用流程上，对于每个请求接口，都需要添加@ApiOperation注解,并指定authorizations参数，标识出使用的是哪种认证方式 swagger认证在实际业务场景中遇到的问题 对于非资深的swagger用户来说，大多数的使用场景，直接加入swagger依赖，启动项目，使用swagger-ui调试接口，最好提供swagger的默认配置行为 实
Swagger与OAuth 手动搭建WebApi 操作笔记
baiyunong1990的博客
06-29 270
1、创建一个空的Web应用程序 2、通过nuget 安装以下插件清单,有部分会在安装其他插件时候自动安装： 3、安装完Swagger 会生成一个目录App_Start，在这个目录中增加文件ApiConfig.cs 配置路由相关信息 　 public static void Register(HttpConfiguration config) ...
mallcloud商城-其他
06-12
真正实现了基于RBAC、jwt和oauth2的无状态统一权限认证的解决方案，面向互联网设计同时适合B端和C端用户，支持CI/CD多环境部署，并提供应用管理方便第三方系统接入；同时还集合各种微服务治理功能和监控功能。模块...
oAuth2.0WithSwaggerUI2.0:使用OAuth2 JWT保护Swagger API
05-13
OAuth 2.0 Swagger-UI 如何运行？ mvn clean mvn spring-boot:run Swagger-UI 启动应用程序后，单击 配置 我使用H2 DB来获取有关用户的信息，您可以在添加用户 为了保护方法，可以在（ResourceServerConfiguration.java）中添加映射 public void configure(HttpSecurity http) throws Exception { http .csrf().disable() .anonymous().disable() .authorizeRequests() .antMatchers(HttpMethod.OPTIONS).permi
mallcloud商城 v1.0
04-22
真正实现了基于RBAC、jwt和oauth2的无状态统一权限认证的解决方案，面向互联网设计同时适合B端和C端用户，支持CI/CD多环境部署，并提供应用管理方便第三方系统接入；同时还集合各种微服务治理功能和监控功能。模块...
Laravel开发-eveapi
08-28
2. **自动处理 OAuth2**：包内集成了 OAuth2 的认证流程，包括令牌获取、刷新和管理，开发者无需关心底层实现。 3. **请求缓存**：为了提高性能，`eveapi` 支持将请求结果缓存，避免频繁的网络通信。 4. **错误处理*...
MagiksVehicleHelperAPI:API仅允许朋友使用
05-05
使用MagiksVehicleHelperAPI的朋友可能需要实现特定的认证机制来接入这些API，例如，他们可能需要提供特定的密钥或者进行身份验证，以证明他们是被授权的开发者或者项目。这涉及到网络安全和授权管理的知识，包括...
Springdoc Swagger UI集成OAuth2认证
罗小爬的技术宝书
02-26 2688
本文主要介绍了Springdoc Swagger UI集成OAuth2认证的3种方式：Bearer Token、标准OAuth2授权码流程、集成OIDC发现端点。
swagger2集成auth认证
PatrickHuan的博客
03-02 658
Swagger的Maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springf
Swagger2+oauth2配置
csdn_xsong的博客
01-24 943
导入依赖 <!-- Swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </d.
oauth2一直弹认证框
qq_42533633的博客
09-18 2629
oauth2一真弹认证框时
springboot swagger oauth2 token鉴权实现代码及原理
06-13
Spring Boot是一个快速开发框架，Swagger是一个API文档生成工具，OAuth2是一个授权框架，可以用于保护API。 下面是Spring Boot集成Swagger和OAuth2的代码实现和原理解释： 1. 添加Swagger依赖 在pom.xml中添加Swagger依赖： ```xml <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> ``` 2. 添加Swagger配置 在Spring Boot的配置类中添加Swagger配置： ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } ``` 3. 添加OAuth2依赖 在pom.xml中添加OAuth2依赖： ```xml <dependency> <groupId>org.springframework.security.oauth.boot</groupId> <artifactId>spring-security-oauth2-autoconfigure</artifactId> <version>2.1.4.RELEASE</version> </dependency> ``` 4. 添加OAuth2配置 在Spring Boot的配置类中添加OAuth2配置： ```java @Configuration @EnableResourceServer public class ResourceServerConfig extends ResourceServerConfigurerAdapter { @Override public void configure(HttpSecurity http) throws Exception { http.authorizeRequests().anyRequest().authenticated(); } } ``` 5. 添加Token鉴权 添加Token鉴权的方式是在控制器方法上添加@PreAuthorize注解，指定需要的角色或权限： ```java @RestController @RequestMapping("/api") public class ApiController { @GetMapping("/hello") @PreAuthorize("hasRole('ADMIN')") public String hello() { return "Hello World!"; } } ``` 6. 请求Token 使用OAuth2的客户端工具请求Token： ```java public class OAuth2Client { public static void main(String[] args) { Base64.Encoder encoder = Base64.getEncoder(); String clientCredentials = "client_id:client_secret"; String encodedClientCredentials = encoder.encodeToString(clientCredentials.getBytes()); String url = "http://localhost:8080/oauth/token"; HttpHeaders headers = new HttpHeaders(); headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON)); headers.add("Authorization", "Basic " + encodedClientCredentials); MultiValueMap<String, String> map = new LinkedMultiValueMap<>(); map.add("grant_type", "client_credentials"); HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers); RestTemplate restTemplate = new RestTemplate(); ResponseEntity<String> response = restTemplate.postForEntity(url, request, String.class); System.out.println(response.getBody()); } } ``` 以上就是Spring Boot集成Swagger和OAuth2的代码实现和原理解释。其中Swagger用于生成API文档，OAuth2用于保护API，Token鉴权用于限制访问API的角色或权限。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值