Springboot ✚ Swagger各版本整理

布满荆棘的人生 2023-10-12 18:44 27阅读 0赞

#### Springboot ✚ [Swagger][]各版本整理 ####

*  swagger配置变化原因：
 *  Swagger版本
 *   *  1、Swagger 2.x 版本
     *   *  springboot 2.5.6 ✚ swagger 2.6.1~2.9.2配置属下
     *  2、Swagger 3.x 版本
     *   *  springboot 2.5.6 ✚ swagger 3.0.0配置属下
         *  springboot 2.6.5 ✚ swagger 3.0.0配置属下
 *  Knife4j 版本
 *   *  Knife4j 3.0.3 ✚ Springboot2.7.1

## [swagger配置][swagger]变化原因： ##

1.  **SpringBoot处理映射匹配的默认策略发生变化**
    
    请求路径与 Spring MVC 处理映射匹配的默认策略已从AntPathMatcher更改为PathPatternParser。你可以设置spring.mvc.pathmatch.matching-strategy为ant-path-matcher来改变它。

*  springboot 2.6.0之前
    
        public static class Pathmatch {
               
        	private MatchingStrategy matchingStrategy = MatchingStrategy.ANT_PATH_MATCHER;
        }
        
            
            
             
            
            
             
              1 
              2 
              3
 *  springboot2.6.0之后
    
        public static class Pathmatch {
               
            private MatchingStrategy matchingStrategy = MatchingStrategy.PATH_PATTERN_PARSER;
        }
        
            
            
             
            
            
             
              1 
              2 
              3
    
    如果升级springboot到2.6之后，需要设置`spring.mvc.pathmatch.matching-strategy=ant-path-matcher`来兼容Swagger2

2.**Swagger升级**

## Swagger版本 ##

### 1、Swagger 2.x 版本 ###

<table> 
 <thead> 
  <tr> 
   <th>swagger</th> 
   <th>访问路径</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>3.0.0之前</td> 
   <td>http://127.0.0.1:8080/swagger-ui.html</td> 
  </tr> 
  <tr> 
   <td>3.0.0之后</td> 
   <td>http://127.0.0.1:8080/swagger-ui/index.html</td> 
  </tr> 
 </tbody> 
</table>

#### springboot 2.5.6 ✚ swagger 2.6.1~2.9.2配置属下 ####

<parent>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-parent</artifactId>
    	<version>2.5.6</version>
    </parent>
    <dependency>
    	<groupId>io.springfox</groupId>
    	<artifactId>springfox-boot-starter</artifactId>
    	<version>2.6.1</version>  2.7.0   2.8.0   2.9.2  都可以
    </dependency>
    
      
      
       
      
      
       
        1 
        2 
        3 
        4 
        5 
        6 
        7 
        8 
        9 
        10

只需要在启动类上加 `@EnableSwagger2` 注解即可  
访问地址：**http://127.0.0.1:8080/swagger-ui.html**

### 2、Swagger 3.x 版本 ###

#### springboot 2.5.6 ✚ swagger 3.0.0配置属下 ####

<parent>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-parent</artifactId>
    	<version>2.5.6</version>
    </parent>
    <dependency>
    	<groupId>io.springfox</groupId>
    	<artifactId>springfox-boot-starter</artifactId>
    	<version>3.0.0</version>
    </dependency>
    
      
      
       
      
      
       
        1 
        2 
        3 
        4 
        5 
        6 
        7 
        8 
        9 
        10

只需要在启动类上加 `@EnableSwagger2`注解即可  
访问地址：**http://127.0.0.1:8080/swagger-ui/index.html**

#### springboot 2.6.5 ✚ swagger 3.0.0配置属下 ####

<parent>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-parent</artifactId>
    	<version>2.6.5</version>
    </parent>
    <dependency>
    	<groupId>io.springfox</groupId>
    	<artifactId>springfox-boot-starter</artifactId>
    	<version>3.0.0</version>
    </dependency>
    
      
      
       
      
      
       
        1 
        2 
        3 
        4 
        5 
        6 
        7 
        8 
        9 
        10

application.yml 或applicaiton.properties 中添 必须 加如下配置

spring:
      mvc:
        pathmatch:
          matching-strategy: ant_path_matcher
    
      
      
       
      
      
       
        1 
        2 
        3 
        4

只需要在启动类上加 `@EnableSwagger2` 注解即可  
访问地址：**http://127.0.0.1:8080/swagger-ui/index.html**

## [Knife4j][] 版本 ##

访问地址：**http://127.0.0.1:8080/doc.html**，访问方式和之前的保持一致，如果项目中配置拦截器等，需要放开doc.html静态资源

<table> 
 <thead> 
  <tr> 
   <th align="left">版本</th> 
   <th align="left">说明</th> 
   <th align="left">SpringBoot</th> 
   <th align="center">配置注解</th> 
   <th align="center">增强功能</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">1.9.6</td> 
   <td align="left">蓝色皮肤风格，增加更多后端模块</td> 
   <td align="left"></td> 
   <td align="center"><code>@EnableSwagger2</code></td> 
   <td align="center">不支持</td> 
  </tr> 
  <tr> 
   <td align="left">2.0~2.0.5</td> 
   <td align="left">Ui重写，蓝色背景变成黑色，底层依赖的springfox框架版本是2.9.2</td> 
   <td align="left"></td> 
   <td align="center"><code>@EnableSwagger2</code></td> 
   <td align="center">开启方式<code>@EnableKnife4j</code></td> 
  </tr> 
  <tr> 
   <td align="left">2.0.6~</td> 
   <td align="left">底层springfox框架版本升级知2.10.5,OpenAPI规范是v2</td> 
   <td align="left">大于等于2.2.x (2.6.0之后需要需要设置<code>spring.mvc.pathmatch.matching-strategy =ant-path-matcher</code>)</td> 
   <td align="center"><code>@EnableSwagger2WebMvc</code></td> 
   <td align="center">开启方式<code>knife4j.enable=true</code>默认不开启</td> 
  </tr> 
  <tr> 
   <td align="left">3.0~</td> 
   <td align="left">底层依赖springfox框架版本升级至3.0.3,OpenAPI规范是v3</td> 
   <td align="left">大于等于2.2.x(2.6.0之后需要需要设置<code>spring.mvc.pathmatch.matching-strategy =ant-path-matcher</code>)</td> 
   <td align="center">写不写都可以</td> 
   <td align="center">开启方式<code>knife4j.enable=true</code>默认不开启</td> 
  </tr> 
 </tbody> 
</table>

### Knife4j 3.0.3 ✚ Springboot2.7.1 ###

<parent>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-parent</artifactId>
    	<version>2.7.1</version>
    </parent>
    <dependency>
    	<groupId>com.github.xiaoymin</groupId>
    	<artifactId>knife4j-spring-boot-starter</artifactId>
    	<version>3.0.3</version>
    </dependency>
    
      
      
       
      
      
       
        1 
        2 
        3 
        4 
        5 
        6 
        7 
        8 
        9 
        10

spring:
      mvc:
        pathmatch:
          matching-strategy: ant_path_matcher
    
      
      
       
      
      
       
        1 
        2 
        3 
        4

[Knife4j 3.0.3 增强功能配置][Knife4j 3.0.3]

[Swagger]: https://so.csdn.net/so/search?q=Swagger&spm=1001.2101.3001.7020
[swagger]: https://so.csdn.net/so/search?q=swagger%E9%85%8D%E7%BD%AE&spm=1001.2101.3001.7020
[Knife4j]: https://so.csdn.net/so/search?q=Knife4j&spm=1001.2101.3001.7020
[Knife4j 3.0.3]: https://doc.xiaominfo.com/knife4j/documentation/enhance.html