Swagger整合Jwt授权配置

Posted 2022-03-18 老方学IT

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依赖

<!--swagger-->
<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>

2）创建swagger配置文件

@Configuration
@EnableSwagger2
public class Swagger2Config 

    @Bean
    public Docket apiConfig() 
        //创建基于Swagger2的配置文件
        return new Docket(DocumentationType.SWAGGER_2)
                // 调用apiInfo方法,创建一个ApiInfo实例,里面是展示在文档页面信息内容
                .apiInfo(apiInfo());
    
    private ApiInfo apiInfo() 
        return new ApiInfoBuilder()
                //标题
                .title("接口文档")
                //描述
                .description("接口文档")
                //版本
                .version("1.0")
                //作者信息
                .contact(new Contact("java大师", "http://localhost:8081", "[e-mail]"))
                .build();
    

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

此为原生界面，很难看，所以我们需要引入swagger-bootstrap-ui，也就是Knife4j的前身
4）使用Knife4j
a）添加pom.xml依赖

<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-spring-boot-starter</artifactId>
  <version>2.0.7</version>
</dependency>

b）开启Swagger2配置

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class Swagger2Config 
    @Bean
    public Docket createRestApi() 
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .apiInfo(apiInfo())
                .select()
                //swagger要扫描的包路径
                .apis(RequestHandlerSelectors.basePackage("com.dsblog.server.controller"))
                .paths(PathSelectors.any())
                .build()
    

    private ApiInfo apiInfo() 
        return new ApiInfoBuilder().title("dsblog接口文档")
                .contact(new Contact("java大师","http://localhost:8081/doc.html","[e-mail]"))
                .version("1.0").description("dsblog接口文档").build();
    

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

二、Swagger整合Jwt

1、添加pom.xml依赖

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>com.dsblog</groupId>
    <artifactId>dsblog</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>

  <groupId>com.dsblog</groupId>
  <artifactId>dsblog-server</artifactId>
  <version>0.0.1-SNAPSHOT</version>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <scope>runtime</scope>
    </dependency>
    <dependencySwagger + spring boot + jwt + 如何禁用特定 API 的授权按钮

 swagger文档添加jwt认证
 Spring Security整合JWT实现权限认证和授权
 如何使用 openapi-ui 和承载令牌（jwt）在 swagger-ui 中激活授权按钮？
 SpringBoot技术专题「权限校验专区」Shiro整合JWT授权和认证实现
 .NetCore WebApi —— Swagger版本控制