6. API 版本验证
平台需要在每次调用 Open Service Broker API 时提供 HTTP 标头,以指示平台支持的 API 规范版本。 您可以配置 Spring Cloud Open Service Broker 以验证平台在每次调用 Service Broker 时提供的版本。 默认情况下,此版本验证配置为允许任何 API 版本。
要自定义版本验证,请将apiVersion
指定 Service Broker 所需的 API 版本的属性,如下所示:
spring.cloud.openservicebroker.apiVersion=2.13
或者,您也可以提供BrokerApiVersion
Spring bean 中,如下所示:
package com.example.servicebroker;
@Configuration
public class ExampleApiVersionConfiguration {
@Bean
public BrokerApiVersion brokerApiVersion() {
return new BrokerApiVersion("2.13");
}
}
如果同时配置了 Spring Bean 和属性,则 Spring Bean 优先于该属性。
如果指定了 API 版本,并且平台在X-Broker-API-Version
标头,框架会返回一个412 Precondition Failed
错误。
如前所述,默认版本验证配置为允许任何 API 版本。
但是,要完全禁用版本验证,您可以将api-version-check-endabled
property 设置为false
如下:
spring.cloud.openservicebroker.api-version-check-enabled = false