swagger与oauth的集成使用

最新推荐文章于 2024-07-02 15:27:37 发布
最新推荐文章于 2024-07-02 15:27:37 发布
阅读量4k 收藏 1
点赞数
分类专栏： 大数据 微服务 文章标签： swagger与oauth的集成使用
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ZHBR_F1/article/details/84943578
版权

1.Swagger定义

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
个人觉得，swagger的一个最大的优点是能实时同步api与文档。在项目开发过程中，发生过多次：修改代码但是没有更新文档，前端还是按照老旧的文档进行开发，在联调过程中才发现问题的情况（当然依据开闭原则，对接口的修改是不允许的，但是在项目不稳定阶段，这种情况很难避免）。
作用：

  1. 接口的文档在线自动生成。
  2. 功能测试。

2.示例

2.1 引入依赖

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.7.0</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.7.0</version>
</dependency>
 <dependency>
	<groupId>com.joinbright.f1</groupId>
	<artifactId>f1-component</artifactId>
 	<version>3.2.0-SNAPSHOT</version>
</dependency>

第一个是API获取的包，第二是官方给出的一个ui界面。

2.2 SwaggerConfigure

@Configuration
@EnableSwagger2
public class SwaggerConfigure implements Serializable {
        // 2.针对授权认证
        //    security.userOauth.clientId
        @Value("${security.userOauth.clientId}")
        private String authClientId;

        //    security.userOauth.clientSecret
        @Value("${security.userOauth.clientSecret}")
        private String authClientSecret;

        @Value("${security.userOauth.type}")
        private String type;

        //    security.userOauth.authorizationUrl
        @Value("${security.userOauth.authorizationUrl}")
        private String authorizationUrl;

        //    security.userOauth.tokenUrl
        @Value("${security.userOauth.tokenUrl}")
        private String tokenUrl;

        @Value("${security.userOauth.tokenName}")
        private String tokenName;

        @Value("${security.userOauth.scope.code}")
        private String scopeCode;

        @Value("${security.userOauth.scope.desc}")
        private String scopeDesc;

        @Value("${app.key}")
        private String appKey;

        @Value("${app.name}")
        private String appName;

        @Value("${app.desc}")
        private String appDesc;

        @Value("${app.version}")
        private String appVersion;

        @Value("${app.termsOfServiceUrl}")
        private String termsOfServiceUrl;

        @Value("${app.contact.name}")
        private String contactName;


        /**
         * Api分组，可以定义多个组
         */
        @Bean
        public Docket jackApi() {
            return new Docket(DocumentationType.SWAGGER_2).groupName("jack")
                    .genericModelSubstitutes(DeferredResult.class)
                    .useDefaultResponseMessages(false)
                    .forCodeGeneration(true)
                    .pathMapping("/")
                    .select()
                    //                .apis(RequestHandlerSelectors.basePackage("net.jack.lt"))
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .paths(PathSelectors.any())
                    .build()
                    .securitySchemes(newArrayList(oauth()))
                    .securityContexts(newArrayList(securityContext()))
                    .apiInfo(apiInfo());
        }

        private ApiInfo apiInfo() {
            ApiInfo apiInfo = new ApiInfoBuilder()
                    .title(appName)
                    .description(appDesc)
                    .termsOfServiceUrl(termsOfServiceUrl)
                    .contact(contactName)
                    .version(appVersion)
                    .build();
            return apiInfo;
        }
        
        @Bean
        SecurityScheme apiKey() {
            return new ApiKey(appName, appKey, "header");
        }

        @Bean
        SecurityContext securityContext() {
            AuthorizationScope[] scopes = new AuthorizationScope[]{new AuthorizationScope(scopeCode, scopeDesc)};
            SecurityReference securityReference = SecurityReference
                    .builder()
                    .reference(type)
                    .scopes(scopes)
                    .build();

            return SecurityContext
                    .builder()
                    .securityReferences(newArrayList(securityReference))
                    .forPaths(PathSelectors.any())//ant("/api/**") // 最好是能够统一前缀
                    .build();
        }

        @Bean
        SecurityScheme oauth() {
            return new OAuthBuilder()
                    .name(type)
                    .grantTypes(grantTypes())
                    .scopes(scopes())
                    .build();
        }

        List<AuthorizationScope> scopes() {
            return newArrayList(new AuthorizationScope(scopeCode, scopeDesc));
        }

        List<GrantType> grantTypes() {
            List<GrantType> grants = newArrayList(new AuthorizationCodeGrant(
                    new TokenRequestEndpoint(authorizationUrl, authClientId, authClientSecret),
                    new TokenEndpoint(tokenUrl, tokenName)));
            return grants;
        }

        @Bean
        public SecurityConfiguration securityInfo() {
            return new SecurityConfiguration(authClientId, authClientSecret, scopeCode, 
                    appKey, appKey, ApiKeyVehicle.HEADER, "", ",");
        }
}

基础的配置是对整个API文档的描述以及一些全局性的配置，对所有接口起作用。这里涉及到两个注解： 　　
@Configuration是表示这是一个配置类，是JDK自带的注解，前面的文章中也已做过说明。 　　
@EnableSwagger2的作用是启用Swagger2相关功能。 在这个配置类里面我么实例化了一个Docket对象，这个对象主要包括三个方面的信息： 　　　
　（1）整个API的描述信息，即ApiInfo对象包括的信息，这部分信息会在页面上展示。
　（2）指定生成API文档的包名。 　　　　
　（3）指定生成API的路径。按路径生成API可支持四种模式，这个可以参考其源码：

2.3 WebMvcConfig

@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {

   /**
     * 将Swagger2 的swagger-ui.html加入资源路径下,否则Swagger2静态页面不能访问。要想使资源能够访问，可以有两种方法
     * 一：需要配置类继承WebMvcConfigurationSupport 类，实现addResourceHandlers方法。
     *      但是实现了WebMvcConfigurationSupport以后，Spring Boot的 WebMvc自动配置就会失效，具体表现比如访问不到
     *      静态资源（js，css等）了，这是因为WebMvc的自动配置都在WebMvcAutoConfiguration类中，但是类中有这个注解
     *      @ConditionalOnMissingBean({WebMvcConfigurationSupport.class})，意思是一旦在容器中检测到
     *      WebMvcConfigurationSupport这个类，WebMvcAutoConfiguration类中的配置都不生效。
     *      所以一旦我们自己写的配置类继承了WebMvcConfigurationSupport，相当于容器中已经有了WebMvcConfigurationSupport，
     *      所有默认配置都不会生效，都得自己在配置文件中配置。
     * 二：继承WebMvcConfigurer接口，这里采用此方法 网上有人说使用该方法会导致date编译等问题，可能在配置文件中得到解决，
     *      本人没有碰到，不多做解释
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}

2.4 ResourceServerConfiguration

@Configuration
@EnableResourceServer
@Order(100)
public class ResourceServerConfiguration extends ResourceServerConfigurerAdapter {
    @Autowired
    private RedisConnectionFactory connectionFactory;

    @Override
    public void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests().antMatchers(StaticParams.SWAGGERUI.getSwaggerResource()).permitAll()
                .anyRequest().authenticated();
        // 设置通用的session创建策略
        http.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.IF_REQUIRED);
    }


    @Bean
    public TokenStore tokenStore() {
        return new RedisTokenStore(connectionFactory);
    }

}

2.5 StaticParams

    public class StaticParams {
    public static class USERROLE {
        public static final String ROLE_ADMIN = "ROLE_ADMIN";
        public static final String ROLE_USER = "ROLE_USER";
        public static final String ROLE_SUPER = "ROLE_SUPER";
    }

    public static class PATHREGX {

        private final static String getPathRex(String path) {
            return "/" + path + "/**";
        }

        public static final String ALL = getPathRex(PATH.ALL);
        public static final String VIEW = getPathRex(PATH.VIEW);
        public static final String ADMIN = getPathRex(PATH.ADMIN);
        public static final String API = getPathRex(PATH.API);
        public static final String RESOURCE = getPathRex(PATH.RESOURCE);
        public static final String STATIC = getPathRex(PATH.STATIC);
        public static final String JS = getPathRex(PATH.JS);
        public static final String CSS = getPathRex(PATH.CSS);
        public static final String IMG = getPathRex(PATH.IMG);
    }

    public static class PATH {
        public static final String ALL = "**";
        public static final String VIEW = "view";
        public static final String ADMIN = "admin";
        public static final String API = "api";
        public static final String RESOURCE = "resource";
        public static final String STATIC = "static";
        public static final String JS = "js";
        public static final String CSS = "css";
        public static final String IMG = "img";
        public static final String WEBSOCKET_SERVICE = "websocket-service";
        public static final String WEBSOCKET = "websocket";
    }

    /**
     * 
     * @Package: com.jb.auth.sso<br>
     * @ClassName: SWAGGERUI<br>
     * @Description: swagger限制地址<br>
     */
    public static class SWAGGERUI {
        public static final String MAIN = "/**/swagger-ui.html";
        public static final String RESOURCES = "/**/swagger-resources/**";
        public static final String API_DOCS = "/**/api-docs";
        public static final String STATIC_RESOURCES = "/**/webjars/springfox-swagger-ui/**";
        /**
         * 
         * @Title: getSwaggerResource
         * @Description: 获取swagger对应ui资源
         * @return
         */
        public static String[] getSwaggerResource() {
            return new String[] { MAIN, RESOURCES, API_DOCS, STATIC_RESOURCES};
        }
    }

}

2.6 API接口

   @ApiOperation("基于分页查询计算点")
    @ApiImplicitParams({
       @ApiImplicitParam(name = "page", value = "页码", paramType = "query", required = true, dataType = "Integer"),
        @ApiImplicitParam(name = "size", value = "条数", paramType = "query", required = true, dataType = "Integer")
    })
    @RequestMapping(path = "/_all/_page", method = RequestMethod.GET)
    @ResponseStatus(code = HttpStatus.OK)
    public InvokeResult<Page<Rule>> findRuleByQueryPage(@RequestParam("page") Integer page,
    @RequestParam("size")Integer size) {
        CheckUtil.CheckPageIndexAndSizeAsException(page,size);

        Page<Rule> ruleCriteria = service.findRuleCriteria(page,size);
        return  InvokeResultUtil.ofSuccessful(ruleCriteria);
    }

@ApiOperation() 用于方法；表示一个http请求的操作 value用于方法描述 notes用于提示内容 tags可以重新分组（视情况而用）

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

@ApiImplicitParams：用在方法上包含一组参数说明
@ApiImplicitParam： 用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
paramType：参数放在哪个地方
header 请求参数的获取：@RequestHeader
query 请求参数的获取：@RequestParam
path（用于restful接口）请求参数的获取：@PathVariabl
body（不常用）
form（不常用）
name：参数名
dataType：参数类型
required：参数是否必须传
value：参数的意思
defaultValue：参数的默认值

2.7 application.yaml配置

security:
  userOauth:
    clientId: f1autoauth
    clientSecret: f1autoauthsecret
    type: oauth2
    authorizationUrl: http://192.168.1.23:9080/uaa/oauth/authorize
    tokenUrl: http://192.168.1.23:9080/uaa/oauth/token
    tokenName: access_token
    scope:
      code: write
      desc: write
app:
  key: swagger
  name: Stark平台在线API
  desc: 详情http://192.168.1.173/F1-IoT/stark
  version: 1.0.0
  termsOfServiceUrl: http://192.168.1.173/F1-IoT/stark
  contact:
    name: 大数据组

2.8 swagger测试接口
在Chrome浏览器中输入地址：http://ip:port/swagger-ui.html，即可打开swagger-ui界面测试接口。
在这里插入图片描述

ZHBR_F1
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot：解决使用Oauth2后swagger不显示的问题
泛泛之素
07-18 4735
在 WebSecurity的配置类中设置放行swagger相关资源 @Configuration @EnableWebSecurity public class WebSecurityConfig extends WebSecurityConfigurerAdapter { @Override public void configure(WebSecurity web) throws Exception { web.ignoring() .a
swagger集成与使用
lgy_lucky的博客
11-20 1786
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。简单来说，Swagger可以通过使用注解来生成接口文档，使得后端开发人员不必接口文档和代码各维护一套，代码即接口文档，代码更新接口文档可以自动更新。本篇文章主要讲解Springboot集成Swagger的配置，以及Swagger常用注解。另外，Swagger也提供了根据接口文档生成前后端代码的功能，在此不做介绍。
Swagger整合Oauth2
飘渺Jam的博客
03-08 5189
Swagger整合Oauth2
在使用Swagger-Knife4j时，如何配置Oauth2认证功能？
最新发布
qq_39508627的博客
07-02 493
在使用Swagger-Knife4j时，配置OAuth2认证功能可以通过以下步骤实现。
Springdoc Swagger UI集成OAuth2认证
罗小爬的技术宝书
02-26 2793
本文主要介绍了Springdoc Swagger UI集成OAuth2认证的3种方式：Bearer Token、标准OAuth2授权码流程、集成OIDC发现端点。
Swagger接入OAuth2认证
qq_42383970的博客
11-22 3491
1.pom依赖 在所要使用Swagger的项目引用Swagger依赖 <dependencies> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </depe
swagger2集成auth认证
PatrickHuan的博客
03-02 671
Swagger的Maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springf
集成Swagger
qq_46054503的博客
03-22 2615
集成步骤： 1、集成swagger需要导入下面两个依赖： <!--引入swagger支持--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- htt
Swagger UI 集成 OAuth2 授权服务
热门推荐
github_39939645的博客
04-27 2万+
在开发 Rest API 时，经常会使用 swagger 进行 API 测试，但是 API 通常情况下都是受保护的，需要携带 token 才能访问，本篇文章将介绍在 Spring Boot 中，swagger 怎样与 OAuth2 服务集成。 本文所使用的环境： Java8 Spring Boot 2.0 Spring OAuth2 Keycloak OAuth2 认证服务器 Gra...
SpringSecurityOAuth2(8) swagger2 集成OAuth2
08-05 1577
GitHub地址 码云地址 swagger是一款优雅的接口api展示工具，在这里我们具体不展开讲解，有兴趣的自行百度。 该篇文章主要讲解的是如何集成OAuth2的验证即在请求中添加token，验证接口是否具有权限。 方式一：在每个请求上加一个Authorization 窗口自己手动输入toke...
swagger与OAuth 2.0：实现安全的API授权
# 一、理解Swagger与OAuth 2.0 ## a. Swagger简介与作用 Swagger是一个开源工具集，用于构建、文档化和调用RESTful风格的Web服务。它集成了各种开发框架和工具，提供了统一的方式来描述、展示和测试API接口。通过...
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
Springboot引入拦截器并放行swagger代码实例
08-25
主要介绍了Springboot引入拦截器并放行swagger代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
spring boot security oauth2例子
04-01
一个springboot为框架的security oauth2应用例子，同时集成了swagger2的 restful API查看页面，druid数据源监控, mybatis自动生成和分页插件，远程资源服务器的认证和授权，也可以去github下载 ...
Springboot Oauth2 集成Swagger2权限验证实战
entfrm的博客
04-22 1888
Swagger是什么？能干什么？在这就不展开讲解了。本文主要讲解如何集成OAuth2的Password模式权限验证，验证接口是否具有权限。 引入依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactI...
Swagger与OAuth 手动搭建WebApi 操作笔记
baiyunong1990的博客
06-29 281
1、创建一个空的Web应用程序 2、通过nuget 安装以下插件清单,有部分会在安装其他插件时候自动安装： 3、安装完Swagger 会生成一个目录App_Start，在这个目录中增加文件ApiConfig.cs 配置路由相关信息 　 public static void Register(HttpConfiguration config) ...
[第二篇]如何在ASP.Net Core的生产环境中使用OAuth保护swagger ui
寒冰屋的专栏
05-01 419
使用 OAuth 2.0 和 OpenIdConnect 进行保护 随着应用程序越来越多地使用 OAuth 和 OpenIdConnect，应用程序很有可能使用 OAuth 和 OpenIDConnect 进行身份验证和授权，在这种情况下，我们希望使用相同的机制来保护 swagger ui，而不是基本身份验证。
Swagger添加oauth2授权
fqydhk的专栏
01-13 1360
交流QQ号:555913397 有什么问题可以加群大家一起交流 Swagger添加oauth2授权 经过百度无果,无奈只能谷歌一下,终成功搞定,现将成功案例分享给大家,不敢藏私. Swagger是一个大家经常使用的工具,用于使用标准JSON格式创建拥有非常漂亮UI的API文档。并且可以在线测试接口。 因为使用了IdentityServer4作为授权服务器，使得客户端需要授权的API在Swagger无法测试。所以有了给Swagger添加Oauth2授权的想法，好了，下面我们开工吧。 首先给客户端添加授权配.
swaggerui集成oauth implicit
weixin_34396902的博客
03-28 172
swaggerui集成oauth implicit 添加引用 Swashbuckle.AspNetCore IdentityServer4.AccessTokenValidation 预先准备好IdentityServer4配置client与Api Resources Startup 配置 Authentication Api Resources 和SwaggerUI Client配置 pu...
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的角色或权限。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值