此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Framework 6.2.7! |
API 版本
要使用请求标头启用 API 版本控制,请使用以下内容:
-
Java
-
Kotlin
@Configuration
public class WebConfiguration implements WebMvcConfigurer {
@Override
public void configureApiVersioning(ApiVersionConfigurer configurer) {
configurer.useRequestHeader("X-API-Version");
}
}
@Configuration
class WebConfiguration : WebMvcConfigurer {
override fun configureApiVersioning(configurer: ApiVersionConfigurer) {
configurer.useRequestHeader("X-API-Version")
}
}
或者,可以从请求参数、路径段、
或通过自定义ApiVersionResolver
.
从路径段解析时,请考虑在 Path Matching 选项中配置一次路径前缀。 |
原始版本值使用SemanticVersionParser
,但您可以使用
自定义 ApiVersionParser 的 ApiVersionParser 进行自定义。
“支持的”版本以透明方式从请求映射中声明的版本中检测到
为方便起见,但您也可以显式设置支持的版本列表,以及
忽略已声明的。版本不受支持的请求将被拒绝,并显示InvalidApiVersionException
导致 400 响应。
配置 API 版本控制后,您可以开始根据请求版本将请求映射到控制器方法。