Swagger整合Jwt授权配置

欢迎关注博主公众号「Java大师」, 专注于分享Java领域干货文章http://www.javaman.cn/sb2/swagger-jwt

一、Swagger入门

1、什么是Swagger

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务，它有着如下的优点：

1）及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)

2）规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)

3）一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)

4）可测性 (直接在接口文档上进行测试，以方便理解业务)

2、Swagger生成文档

1）添加pom.xml依赖

  1. <!--swagger-->
  2. <dependency>
  3. 	<groupId>io.springfox</groupId>
  4. 	<artifactId>springfox-swagger2</artifactId>
  5. 	<version>2.7.0</version>
  6. </dependency>
  7. <dependency>
  8. 	<groupId>io.springfox</groupId>
  9. 	<artifactId>springfox-swagger-ui</artifactId>
  10. 	<version>2.7.0</version>
  11. </dependency>

2）创建swagger配置文件

  1. @Configuration
  2. @EnableSwagger2
  3. public class Swagger2Config {
  5.     @Bean
  6.     public Docket apiConfig() {
  7.         //创建基于Swagger2的配置文件
  8.         return new Docket(DocumentationType.SWAGGER_2)
  9.                 // 调用apiInfo方法,创建一个ApiInfo实例,里面是展示在文档页面信息内容
  10.                 .apiInfo(apiInfo());
  11.     }
  12.     private ApiInfo apiInfo() {
  13.         return new ApiInfoBuilder()
  14.                 //标题
  15.                 .title("接口文档")
  16.                 //描述
  17.                 .description("接口文档")
  18.                 //版本
  19.                 .version("1.0")
  20.                 //作者信息
  21.                 .contact(new Contact("java大师", "http://localhost:8081", "xxx@qq.com"))
  22.                 .build();
  23.     }
  24. }

3）启动程序

访问路径：http://localhost:8081/swagger-ui.html ，出现生成的文档页面。

此为原生界面，很难看，所以我们需要引入swagger-bootstrap-ui，也就是Knife4j的前身

4）使用Knife4j

a）添加pom.xml依赖

  1. <dependency>
  2. 	<groupId>com.github.xiaoymin</groupId>
  3. 	<artifactId>knife4j-spring-boot-starter</artifactId>
  4. 	<version>2.0.7</version>
  5. </dependency>

b）开启Swagger2配置

  1. import java.util.ArrayList;
  2. import java.util.List;
  4. @Configuration
  5. @EnableSwagger2
  6. public class Swagger2Config {
  7.     @Bean
  8.     public Docket createRestApi() {
  9.         return new Docket(DocumentationType.SWAGGER_2)
  10.                 .pathMapping("/")
  11.                 .apiInfo(apiInfo())
  12.                 .select()
  13.                 //swagger要扫描的包路径
  14.                 .apis(RequestHandlerSelectors.basePackage("com.dsblog.server.controller"))
  15.                 .paths(PathSelectors.any())
  16.                 .build()
  17.     }
  19.     private ApiInfo apiInfo() {
  20.         return new ApiInfoBuilder().title("dsblog接口文档")
  21.                 .contact(new Contact("java大师","http://localhost:8081/doc.html","fry000@qq.com"))
  22.                 .version("1.0").description("dsblog接口文档").build();
  23.     }

b）重启服务

访问地址：http://localhost:8081/doc.html，这个ui界面看起来就更美观，更符合国人的使用习惯

二、Swagger整合Jwt

1、添加pom.xml依赖

  1. <?xml version="1.0" encoding="UTF-8"?>
  3. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.   <modelVersion>4.0.0</modelVersion>
  7.   <parent>
  8.     <groupId>com.dsblog</groupId>
  9.     <artifactId>dsblog</artifactId>
  10.     <version>0.0.1-SNAPSHOT</version>
  11.   </parent>
  13.   <groupId>com.dsblog</groupId>
  14.   <artifactId>dsblog-server</artifactId>
  15.   <version>0.0.1-SNAPSHOT</version>
  17.   <properties>
  18.     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  19.     <maven.compiler.source>1.8</maven.compiler.source>
  20.     <maven.compiler.target>1.8</maven.compiler.target>
  21.   </properties>
  23.   <dependencies>
  24.     <dependency>
  25.       <groupId>org.springframework.boot</groupId>
  26.       <artifactId>spring-boot-starter-web</artifactId>
  27.     </dependency>
  28.     <dependency>
  29.       <groupId>org.projectlombok</groupId>
  30.       <artifactId>lombok</artifactId>
  31.       <optional>true</optional>
  32.     </dependency>
  33.     <dependency>
  34.       <groupId>mysql</groupId>
  35.       <artifactId>mysql-connector-java</artifactId>
  36.       <scope>runtime</scope>
  37.     </dependency>
  38.     <dependency>
  39.       <groupId>com.baomidou</groupId>
  40.       <artifactId>mybatis-plus-boot-starter</artifactId>
  41.       <version>3.4.0</version>
  42.     </dependency>
  43.     <dependency>
  44.       <groupId>org.freemarker</groupId>
  45.       <artifactId>freemarker</artifactId>
  46.       <version>2.3.31</version>
  47.     </dependency>
  48.     <dependency>
  49.       <groupId>com.baomidou</groupId>
  50.       <artifactId>mybatis-plus-generator</artifactId>
  51.       <version>3.3.2</version>
  52.     </dependency>
  53.     <dependency>
  54.       <groupId>io.swagger</groupId>
  55.       <artifactId>swagger-annotations</artifactId>
  56.       <version>1.5.20</version>
  57.     </dependency>
  58.     <!--swagger-->
  59.     <dependency>
  60.       <groupId>io.springfox</groupId>
  61.       <artifactId>springfox-swagger2</artifactId>
  62.       <version>2.7.0</version>
  63.     </dependency>
  64.     <dependency>
  65.       <groupId>io.springfox</groupId>
  66.       <artifactId>springfox-swagger-ui</artifactId>
  67.       <version>2.7.0</version>
  68.     </dependency>
  69.     <dependency>
  70.       <groupId>com.github.xiaoymin</groupId>
  71.       <artifactId>knife4j-spring-boot-starter</artifactId>
  72.       <version>2.0.7</version>
  73.     </dependency>
  74.     <dependency>
  75.       <groupId>org.springframework.boot</groupId>
  76.       <artifactId>spring-boot-starter-security</artifactId>
  77.       <version>2.3.6.RELEASE</version>
  78.     </dependency>
  79.     <dependency>
  80.       <groupId>io.jsonwebtoken</groupId>
  81.       <artifactId>jjwt</artifactId>
  82.       <version>0.9.1</version>
  83.     </dependency>
  84.   </dependencies>
  85. </project>

2、创建Swagger2Config配置文件

  1. package com.dsblog.server.config;
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import springfox.documentation.builders.ApiInfoBuilder;
  6. import springfox.documentation.builders.PathSelectors;
  7. import springfox.documentation.builders.RequestHandlerSelectors;
  8. import springfox.documentation.service.*;
  9. import springfox.documentation.spi.DocumentationType;
  10. import springfox.documentation.spi.service.contexts.SecurityContext;
  11. import springfox.documentation.spring.web.plugins.Docket;
  12. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  14. import java.util.ArrayList;
  15. import java.util.List;
  17. @Configuration
  18. @EnableSwagger2
  19. public class Swagger2Config {
  20.     @Bean
  21.     public Docket createRestApi() {
  22.         return new Docket(DocumentationType.SWAGGER_2)
  23.                 .pathMapping("/")
  24.                 .apiInfo(apiInfo())
  25.                 .select()
  26.                 //swagger要扫描的包路径
  27.                 .apis(RequestHandlerSelectors.basePackage("com.dsblog.server.controller"))
  28.                 .paths(PathSelectors.any())
  29.                 .build()
  30.                 .securityContexts(securityContexts())
  31.                 .securitySchemes(securitySchemes());
  32.     }
  34.     private ApiInfo apiInfo() {
  35.         return new ApiInfoBuilder().title("dsblog接口文档")
  36.                 .contact(new Contact("java大师","http://localhost:8081/doc.html","fry000@qq.com"))
  37.                 .version("1.0").description("dsblog接口文档").build();
  38.     }
  40.     private List<SecurityContext> securityContexts() {
  41.         //设置需要登录认证的路径
  42.         List<SecurityContext> result = new ArrayList<>();
  43.         result.add(getContextByPath("/.*"));
  44.         return result;
  45.     }
  47.   //通过pathRegex获取SecurityContext对象
  48.     private SecurityContext getContextByPath(String pathRegex) {
  49.         return SecurityContext.builder()
  50.                 .securityReferences(defaultAuth())
  51.                 .forPaths(PathSelectors.regex(pathRegex))
  52.                 .build();
  53.     }
  55.   	//默认为全局的SecurityReference对象
  56.     private List<SecurityReference> defaultAuth() {
  57.         List<SecurityReference> result = new ArrayList<>();
  58.         AuthorizationScope authorizationScope = new AuthorizationScope("global",
  59.                 "accessEverything");
  60.         AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
  61.         authorizationScopes[0] = authorizationScope;
  62.         result.add(new SecurityReference("Authorization", authorizationScopes));
  63.         return result;
  64.     }
  66.     private List<ApiKey> securitySchemes() {
  67.         //设置请求头信息
  68.         List<ApiKey> result = new ArrayList<>();
  69.         ApiKey apiKey = new ApiKey("Authorization", "Authorization", "header");
  70.         result.add(apiKey);
  71.         return result;
  72.     }
  73. }

3、创建SecurityConfig配置文件

  1. package com.dsblog.server.config.security;
  3. import com.dsblog.server.model.User;
  4. import com.dsblog.server.service.IUserService;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
  9. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  10. import org.springframework.security.config.annotation.web.builders.WebSecurity;
  11. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  12. import org.springframework.security.config.http.SessionCreationPolicy;
  13. import org.springframework.security.core.userdetails.UserDetailsService;
  14. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  15. import org.springframework.security.crypto.password.PasswordEncoder;
  16. import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
  18. @Configuration
  19. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  21.     @Autowired
  22.     private IUserService userService;
  23.     @Autowired
  24.     private RestAuthorizationEntryPoint restAuthorizationEntryPoint;
  25.     @Autowired
  26.     private RestAccessDeniedHandler restAccessDeniedHandler;
  28.     @Override
  29.     protected void configure(AuthenticationManagerBuilder auth) throws Exception {
  30.         auth.userDetailsService(userDetailsService()).passwordEncoder(passwordEncoder());
  31.     }
  33.   	//主要的配置文件，antMatchers匹配的路径，全部忽略，不进行JwtToken的认证
  34.     @Override
  35.     public void configure(WebSecurity web) throws Exception {
  36.         web.ignoring().antMatchers(
  37.                 "/login",
  38.                 "/logout",
  39.                 "/css/**",
  40.                 "/js/**",
  41.                 "/index.html",
  42.                 "favicon.ico",
  43.                 "/doc.html",
  44.                 "/webjars/**",
  45.                 "/swagger-resources/**",
  46.                 "/v2/api-docs/**"
  47.         );
  48.     }
  50.     @Override
  51.     protected void configure(HttpSecurity http) throws Exception {
  52.         http.csrf().disable()
  53.                 .sessionManagement()
  54.                 .sessionCreationPolicy(SessionCreationPolicy.STATELESS)
  55.                 .and()
  56.                 .authorizeRequests()
  57.                 .anyRequest().authenticated()
  58.                 .and()
  59.                 .headers()
  60.                 .cacheControl();
  61.         //添加Jwt登录授权拦截器
  62.         http.addFilterBefore(jwtAuthenticationTokenFilter(), UsernamePasswordAuthenticationFilter.class);
  63.         //添加未登录和未授权结果返回
  64.         http.exceptionHandling()
  65.                 .accessDeniedHandler(restAccessDeniedHandler)
  66.                 .authenticationEntryPoint(restAuthorizationEntryPoint);
  67.     }
  69.     @Override
  70.     @Bean
  71.     public UserDetailsService userDetailsService(){
  72.         return username -> {
  73.             User user = userService.getUserByUsername(username);
  74.             if(null!=user){
  75.                 return user;
  76.             }
  77.             return null;
  78.         };
  79.     }
  81.     @Bean
  82.     public PasswordEncoder passwordEncoder(){
  83.         return new BCryptPasswordEncoder();
  84.     }
  86.     @Bean
  87.     public  JwtAuthenticationTokenFilter jwtAuthenticationTokenFilter(){
  88.         return new JwtAuthenticationTokenFilter();
  89.     }
  90. }

4、创建测试Controller，其中/login登录和/logout退出方法不需要Authorize验证，和上面的重写方法configure(WebSecurity web）匹配，user/info方法需要Authorize验证才能进行访问

  1. package com.dsblog.server.controller;
  3. import com.dsblog.server.model.ResultBean;
  4. import com.dsblog.server.model.User;
  5. import com.dsblog.server.model.UserLoginParam;
  6. import com.dsblog.server.service.IUserService;
  7. import io.swagger.annotations.Api;
  8. import io.swagger.annotations.ApiOperation;
  9. import org.springframework.beans.factory.annotation.Autowired;
  10. import org.springframework.web.bind.annotation.GetMapping;
  11. import org.springframework.web.bind.annotation.PostMapping;
  12. import org.springframework.web.bind.annotation.RequestBody;
  13. import org.springframework.web.bind.annotation.RestController;
  15. import javax.servlet.http.HttpServletRequest;
  16. import java.security.Principal;
  18. @Api(tags = "LoginController")
  19. @RestController
  20. public class LoginController {
  22.     @Autowired
  23.     private IUserService userService;
  25.     @ApiOperation("登录")
  26.     @PostMapping("/login")
  27.     public ResultBean login(@RequestBody UserLoginParam userLoginParam, HttpServletRequest request){
  28.         return userService.login(userLoginParam.getUsername(),userLoginParam.getPassword(),request);
  29.     }
  31.     @ApiOperation("退出")
  32.     @PostMapping("/logout")
  33.     public ResultBean logout(){
  34.         return ResultBean.success("退出成功！");
  35.     }
  37.     @ApiOperation("获取当前登录用户")
  38.     @GetMapping("/user/info")
  39.     public User getUserInfo(Principal principal){
  40.         if(null == principal){
  41.             return null;
  42.         }
  43.         String username = principal.getName();
  44.         User user = userService.getUserByUsername(username);
  45.         user.setPassword(null);
  46.         return user;
  47.     }
  48. }

5、重启程序，输入http://localhost:8081/doc.html

6、测试

1）首先调用/user/info，会看到提示未登录，请先登录。需要登录授权才能够进行方法的测试

2）接着调用登录请求，输入用户名和密码获取JwtToken

3）获取token后，监测网络，发现会将Authorization放入请求头部发送到后台

4）Authorize加入Bearer和JwtToken

5）携带token发送到后台获取用户信息，验证通过

Swagger整合Jwt授权配置的更多相关文章

  1. swagger api文档添加jwt授权配置

    最近写的swagger文档,要加jwt授权,所以几经google终于搞定了,简简单单几行配置如下: securityDefinitions: APIKey: type: apiKey name: Au ...

  2. 【SpringBoot技术专题】「JWT技术专区」SpringSecurity整合JWT授权和认证实现

    JWT基本概念 JWT,即 JSON Web Tokens(RFC 7519),是一个广泛用于验证 REST APIs 的标准.虽说是一个新兴技术,但它却得以迅速流行. JWT的验证过程是: 前端(客 ...

  3. 学习ASP.NET Core(05)-使用Swagger与Jwt授权

    上一篇我们使用IOC容器解决了依赖问题,同时简单配置了WebApi环境,本章我们使用一下Swagger,并通过Jwt完成授权 一.Swagger的使用 1.什么是Swagger 前后端分离项目中,后端 ...

  4. 【SpringBoot技术专题】「权限校验专区」Shiro整合JWT授权和认证实现

    本章介绍一下常用的认证框架Shiro结合springboot以及集合jwt快速带您开发完成一个认证框架机制. Maven配置依赖 <dependency> <groupId>o ...

  5. 如何使用Swagger为.NET Core 3.0应用添加JWT授权说明文档

    简介 本教程采用WHY-WHAT-HOW黄金圈思维模式编写,黄金圈法则强调的是从WHY为什么学,到WHAT学到什么,再到HOW如何学.从模糊到清晰的学习模式.大家的时间都很宝贵,我们做事前先想清楚为什 ...

  6. Spring Boot初识（4）- Spring Boot整合JWT

    一.本文介绍 上篇文章讲到Spring Boot整合Swagger的时候其实我就在思考关于接口安全的问题了,在这篇文章了我整合了JWT用来保证接口的安全性.我会先简单介绍一下JWT然后在上篇文章的基础 ...

  7. swagger的说明、配置及使用

    一.What is swagger? 官方介绍:Swagger是一个规范且完整的框架,提供描述.生产.消费和可视化RESTful Web Service.专业角度:Swagger是由庞大工具集合支撑的 ...

  8. Spring Security整合JWT，实现单点登录，So Easy~！

    前面整理过一篇 SpringBoot Security前后端分离,登录退出等返回json数据,也就是用Spring Security,基于SpringBoot2.1.4 RELEASE前后端分离的情况 ...

  9. net Core3.1 Swagger加JWT权限

    1.Swagger中开启JWT服务 #region swagger services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new ...

随机推荐

  1. Lesson10——NumPy 迭代数组

    NumPy 教程目录 NumPy 迭代数组 NumPy 迭代器对象  numpy.nditer  提供了一种灵活访问一个或者多个数组元素的方式. 迭代器最基本的任务的可以完成对数组元素的访问. Exa ...

  2. notepad++颜色属性解释

    Global Styles Indent guideline style  缩进参考线的颜色Brace highlight style 鼠标指针在框架左右时框架的颜色(如css中{}   js中的() ...

  3. 如何通过opensea-js获取OpenSea的数据

    OpenSea作为NFT最大的交易平台,随着NFT的火热之后,热度也是出现翻天覆地的变化.作为开发人员肯定好奇有没有可以与opensea交互的包来开发相关的工具或者快速获取opensea的数据.别急, ...

  4. 帆软报表（finereport）单元格函数，OP参数

    单元格模型:单元格数据和引用:数据类型.实际值与显示值.单元格支持的操作单元格样式:行高列宽.隐藏行列.自动换行.上下标.文字竖排.大文本字段分页时断开.标识说明.格式刷单元格Web属性:web显示. ...

  5. 《PHP程序员面试笔试宝典》——什么是职场暗语？

    本文摘自<PHP程序员面试笔试宝典> 文末有该书电子版下载. 随着求职大势的变迁发展,以往常规的面试套路因为过于单调.简明,已经被众多"面试达人"们挖掘出了各种&quo ...

  6. 用 Beep 函数让主板“唱”《生日歌》

    用 Beep 函数,让你的主板也会"唱歌".Beep 可以通过控制主板扬声器的发声频率和节拍来演奏美妙的旋律.本文就通过C#演示,调用Beep函数,演奏生日快乐歌.首先我们来看下 ...

  7. Redis 源码简洁剖析 15 - AOF

    AOF 是什么 AOF 持久化的实现 命令追加 AOF 文件的写入和同步 AOF 文件的载入和数据还原 AOF 重写 为什么需要重写 什么是重写 如何重写 AOF 后台重写 为什么需要后台重写 带来的 ...

  8. GitLab API使用小结

    GitLab API使用小结 背景描述 需求描述: 最近因为工作上的需求,需要对GitLab进行大批量的操作,又因为服务器不在境内,所以所有的操作都需要连接VPN来进行FQ访问.目前大概有6000多个 ...

  9. JVM学习——内存空间（学习过程）

    JVM--内存空间 关于内存的内容,内存的划分.JVM1.7 -> 1.8的变化比较大 JVM指令执行的时候,是基于栈的操作.每一个方法执行的时候,都会有一个属于自己的栈帧的数据结构.栈的深度, ...

  10. Java NIO Selector 的使用

    之前的文章已经把 Java 中 NIO 的 Buffer.Channel 讲解完了,不太了解的可以先回过头去看看.这篇文章我们就来聊聊 Selector -- 选择器. 首先 Selector 是用来 ...