6. API 版本验证

平台需要在每次调用 Open Service Broker API 时提供 HTTP 标头,以指示平台支持的 API 规范版本。 您可以配置 Spring Cloud Open Service Broker 以验证平台在每次调用 Service Broker 时提供的版本。 默认情况下,此版本验证配置为允许任何 API 版本。spring-doc.cn

要自定义版本验证,请设置指定 Service Broker 所需 API 版本的属性,如下所示:apiVersionspring-doc.cn

spring.cloud.openservicebroker.apiVersion=2.13

或者,你可以提供一个 Spring Bean,如下所示:BrokerApiVersionspring-doc.cn

package com.example.servicebroker;

import org.springframework.cloud.servicebroker.model.BrokerApiVersion;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class ExampleApiVersionConfiguration {
	@Bean
	public BrokerApiVersion brokerApiVersion() {
		return new BrokerApiVersion("2.13");
	}
}

如果同时配置了 Spring Bean 和属性,则 Spring Bean 优先于该属性。spring-doc.cn

如果指定了 API 版本,并且平台在标头中提供了不同的版本,则框架会向平台返回错误。X-Broker-API-Version412 Precondition Failedspring-doc.cn

如前所述,默认版本验证配置为允许任何 API 版本。 但是,要完全禁用版本验证,可以将该属性设置为 ,如下所示:api-version-check-endabledfalsespring-doc.cn

spring.cloud.openservicebroker.api-version-check-enabled = false