基于SpringBoot整合Swagger2项目API版本控制

基于SpringBoot整合Swagger2项目API版本控制

SpringBoot项目pom配置

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.aeert</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

定义版本号标记注解

package com.loop.demo.annotation;

import org.springframework.web.bind.annotation.Mapping;

import java.lang.annotation.*;

/**
 * @ClassName: ApiVersion
 * @Desc: 接口版本标识注解
 * @version: 1.0
 * @author: loop.fu
 * @date: 2021/8/9 8:46
 */
@Target({
   ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface ApiVersion {
   

    /**
     * 标识版本号
     *
     * @return
     */
    int value();

}

定义版本号标记常量类

package com.loop.demo.constant;

/**
 * @ClassName: ApiVersionConstant
 * @Desc: 类作用描述
 * @version: 1.0
 * @author: loop.fu
 * @date: 2021/8/9 8:46
 */
public interface ApiVersionConstant {
   
    int VERSION_1 = 1;
    int VERSION_2 = 2;
    int VERSION_3 = 3;
    int VERSION_4 = 4;
    int VERSION_5 = 5;
    int VERSION_6 = 6;
    int VERSION_7 = 7;
    int VERSION_8 = 8;
    int VERSION_9 = 9;
}

定义Swagger接口版本标识注解

package com.loop.demo.annotation;
import org.springframework.web.bind.annotation.Mapping;
import java.lang.annotation.*;

/**
 * @ClassName: SwaggerApiVersion
 * @Desc: Swagger接口版本标识注解
 * @version: 1.0
 * @author: loop.fu
 * @date: 2021/8/9 8:46
 */
@Target({
   ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface SwaggerApiVersion {
   
    /**
     * 分组名（即版本号），可以传入多个
     *
     * @return
     */
    String[] value();

}

Swagger接口版本标识常量类