java写api接口源码_SpringBoot实现API接口的完整代码

一、简介

产品迭代过程中，同一个接口可能同时存在多个版本，不同版本的接口URL、参数相同，可能就是内部逻辑不同。尤其是在同一接口需要同时支持旧版本和新版本的情况下，比如APP发布新版本了，有的用户可能不选择升级，这是后接口的版本管理就十分必要了，根据APP的版本就可以提供不同版本的接口。

二、代码实现

本文的代码实现基于SpringBoot 2.3.4-release

1.定义注解

ApiVersion

@Target({ElementType.TYPE, ElementType.METHOD})

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface ApiVersion {

/**

* 版本。x.y.z格式

*

* @return

*/

String value() default "1.0.0";

}

value值默认为1.0.0

EnableApiVersion

/**

* 是否开启API版本控制

*/

@Target(ElementType.TYPE)

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Import(ApiAutoConfiguration.class)

public @interface EnableApiVersion {

}

在启动类上添加这个注解后就可以开启接口的多版本支持。使用Import引入配置ApiAutoConfiguration。

2.将版本号抽象为ApiItem类

ApiItem

@Data

public class ApiItem implements Comparable {

private int high = 1;

private int mid = 0;

private int low = 0;

public static final ApiItem API_ITEM_DEFAULT = ApiConverter.convert(ApiVersionConstant.DEFAULT_VERSION);

public ApiItem() {

}

@Override

public int compareTo(ApiItem right) {

if (this.getHigh() > rig