此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Framework 6.2.10! |
API 版本
要启用 API 版本控制,请使用ApiVersionConfigurer
回调WebMvcConfigurer
:
-
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
:
-
请求标头
-
请求参数
-
路径段
-
媒体类型参数
使用路径段时,请考虑在外部配置共享路径前缀 在路径匹配选项中。 |
默认情况下,该版本是SemanticVersionParser
,但您也可以配置
自定义 ApiVersionParser。
从请求映射中声明的版本中透明地检测到受支持的版本
为了方便起见,但您可以通过 MVC 配置中的标志将其关闭,并且
仅考虑在配置中显式配置为受支持的版本。
具有不受支持版本的请求将被拒绝InvalidApiVersionException
导致 400 个响应。
您可以设置ApiVersionDeprecationHandler
发送有关已弃用的信息
版本到客户端。内置标准处理程序可以设置“弃用”、“日落”和
“Link”标头基于 RFC 9745 和 RFC 8594。
配置 API 版本控制后,您可以开始根据请求版本将请求映射到控制器方法。