Skip to content

Commit c7121d0

Browse files
rstoyanchevrstoyanchev
committed
Replace X-API-Version with API-Version
Closes gh-35494
1 parent 88812ed commit c7121d0

File tree

13 files changed

+29
-29
lines changed

13 files changed

+29
-29
lines changed

‎framework-docs/modules/ROOT/pages/web/webflux/config.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,7 @@ Java::
691691
692692
@Override
693693
public void configureApiVersioning(ApiVersionConfigurer configurer) {
694-
configurer.useRequestHeader("X-API-Version");
694+
configurer.useRequestHeader("API-Version");
695695
}
696696
}
697697
----
@@ -704,7 +704,7 @@ Kotlin::
704704
class WebConfiguration : WebMvcConfigurer {
705705
706706
override fun configureApiVersioning(configurer: ApiVersionConfigurer) {
707-
configurer.useRequestHeader("X-API-Version")
707+
configurer.useRequestHeader("API-Version")
708708
}
709709
}
710710
----

‎framework-docs/src/main/java/org/springframework/docs/web/webmvc/mvcconfig/mvcconfigapiversion/WebConfiguration.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public class WebConfiguration implements WebMvcConfigurer {
2626

2727
@Override
2828
public void configureApiVersioning(ApiVersionConfigurer configurer) {
29-
configurer.useRequestHeader("X-API-Version");
3029
}
30+
configurer.useRequestHeader("API-Version");
3131
}
3232
// end::snippet[]

‎framework-docs/src/main/kotlin/org/springframework/docs/web/webmvc/mvcconfig/mvcconfigapiversion/WebConfiguration.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
2525
class WebConfiguration : WebMvcConfigurer {
2626

2727
override fun configureApiVersioning(configurer: ApiVersionConfigurer) {
28-
configurer.useRequestHeader("X-API-Version")
28+
configurer.useRequestHeader("API-Version")
2929
}
3030
}
3131
// end::snippet[]

‎spring-test/src/test/java/org/springframework/test/web/reactive/server/samples/ApiVersionTests.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public class ApiVersionTests {
4040

4141
@Test
4242
void header() {
43-
String header = "X-API-Version";
43+
String header = "API-Version";
4444

4545
Map<String, String> result = performRequest(
4646
configurer -> configurer.useRequestHeader(header),
@@ -92,7 +92,7 @@ private Map<String, String> performRequest(
9292
@RestController
9393
static class TestController {
9494

95-
private static final String HEADER = "X-API-Version";
95+
private static final String HEADER = "API-Version";
9696

9797
@GetMapping(path = "/**", version = "1.2")
9898
Map<String, String> handle(ServerHttpRequest request) {

‎spring-test/src/test/java/org/springframework/test/web/servlet/client/samples/ApiVersionTests.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public class ApiVersionTests {
4444

4545
@Test
4646
void header() {
47-
String header = "X-API-Version";
47+
String header = "API-Version";
4848

4949
Map<String, String> result = performRequest(
5050
request -> request.getHeader(header), ApiVersionInserter.useHeader(header));
@@ -96,7 +96,7 @@ private Map<String, String> performRequest(
9696
@RestController
9797
private static class TestController {
9898

99-
private static final String HEADER = "X-API-Version";
99+
private static final String HEADER = "API-Version";
100100

101101
@GetMapping(path = "/**", version = "1.2")
102102
Map<String, String> handle(HttpServletRequest request) {

‎spring-web/src/test/java/org/springframework/web/client/RestClientVersionTests.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ void shutdown() {
6464

6565
@Test
6666
void header() {
67-
performRequest(ApiVersionInserter.useHeader("X-API-Version"));
68-
expectRequest(request -> assertThat(request.getHeaders().get("X-API-Version")).isEqualTo("1.2"));
67+
performRequest(ApiVersionInserter.useHeader("API-Version"));
68+
expectRequest(request -> assertThat(request.getHeaders().get("API-Version")).isEqualTo("1.2"));
6969
}
7070

7171
@Test
@@ -101,11 +101,11 @@ void pathSegmentIndexGreaterThanSize() {
101101

102102
@Test
103103
void defaultVersion() {
104-
ApiVersionInserter inserter = ApiVersionInserter.useHeader("X-API-Version");
104+
ApiVersionInserter inserter = ApiVersionInserter.useHeader("API-Version");
105105
RestClient restClient = restClientBuilder.defaultApiVersion(1.2).apiVersionInserter(inserter).build();
106106
restClient.get().uri("/path").retrieve().body(String.class);
107107

108-
expectRequest(request -> assertThat(request.getHeaders().get("X-API-Version")).isEqualTo("1.2"));
108+
expectRequest(request -> assertThat(request.getHeaders().get("API-Version")).isEqualTo("1.2"));
109109
}
110110

111111
private void performRequest(ApiVersionInserter versionInserter) {

‎spring-web/src/test/java/org/springframework/web/client/support/RestClientAdapterTests.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ void greetingWithApiVersion() throws Exception {
187187

188188
RestClient restClient = RestClient.builder()
189189
.baseUrl(anotherServer.url("/").toString())
190-
.apiVersionInserter(ApiVersionInserter.useHeader("X-API-Version"))
190+
.apiVersionInserter(ApiVersionInserter.useHeader("API-Version"))
191191
.build();
192192

193193
RestClientAdapter adapter = RestClientAdapter.create(restClient);
@@ -196,7 +196,7 @@ void greetingWithApiVersion() throws Exception {
196196
String actualResponse = service.getGreetingWithVersion();
197197

198198
RecordedRequest request = anotherServer.takeRequest();
199-
assertThat(request.getHeaders().get("X-API-Version")).isEqualTo("1.2");
199+
assertThat(request.getHeaders().get("API-Version")).isEqualTo("1.2");
200200
assertThat(actualResponse).isEqualTo("Hello Spring 2!");
201201
}
202202

‎spring-webflux/src/test/java/org/springframework/web/reactive/function/client/WebClientVersionTests.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ void shutdown() {
6161

6262
@Test
6363
void header() {
64-
performRequest(ApiVersionInserter.useHeader("X-API-Version"));
65-
expectRequest(request -> assertThat(request.getHeaders().get("X-API-Version")).isEqualTo("1.2"));
64+
performRequest(ApiVersionInserter.useHeader("API-Version"));
65+
expectRequest(request -> assertThat(request.getHeaders().get("API-Version")).isEqualTo("1.2"));
6666
}
6767

6868
@Test
@@ -92,11 +92,11 @@ void pathSegmentIndexGreaterThanSize() {
9292

9393
@Test
9494
void defaultVersion() {
95-
ApiVersionInserter inserter = ApiVersionInserter.useHeader("X-API-Version");
95+
ApiVersionInserter inserter = ApiVersionInserter.useHeader("API-Version");
9696
WebClient webClient = webClientBuilder.defaultApiVersion(1.2).apiVersionInserter(inserter).build();
9797
webClient.get().uri("/path").retrieve().bodyToMono(String.class).block();
9898

99-
expectRequest(request -> assertThat(request.getHeaders().get("X-API-Version")).isEqualTo("1.2"));
99+
expectRequest(request -> assertThat(request.getHeaders().get("API-Version")).isEqualTo("1.2"));
100100
}
101101

102102
private void performRequest(ApiVersionInserter versionInserter) {

‎spring-webflux/src/test/java/org/springframework/web/reactive/function/server/support/RouterFunctionMappingVersionTests.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ void mapVersion() {
7070

7171
private void testGetHandler(String version, String expectedBody) {
7272
MockServerWebExchange exchange = MockServerWebExchange.from(
73-
MockServerHttpRequest.get("/").header("X-API-Version", version));
73+
MockServerHttpRequest.get("/").header("API-Version", version));
7474

7575
Mono<?> result = this.mapping.getHandler(exchange);
7676

@@ -82,7 +82,7 @@ private void testGetHandler(String version, String expectedBody) {
8282
@Test
8383
void deprecation() {
8484
MockServerWebExchange exchange = MockServerWebExchange.from(
85-
MockServerHttpRequest.get("/").header("X-API-Version", "1"));
85+
MockServerHttpRequest.get("/").header("API-Version", "1"));
8686

8787
Mono<?> result = this.mapping.getHandler(exchange);
8888

@@ -105,7 +105,7 @@ public void configureApiVersioning(ApiVersionConfigurer configurer) {
105105
StandardApiVersionDeprecationHandler handler = new StandardApiVersionDeprecationHandler();
106106
handler.configureVersion("1").setDeprecationLink(URI.create("https://example.org/deprecation"));
107107

108-
configurer.useRequestHeader("X-API-Version")
108+
configurer.useRequestHeader("API-Version")
109109
.addSupportedVersions("1", "1.1", "1.3")
110110
.setDeprecationHandler(handler);
111111
}

‎spring-webflux/src/test/java/org/springframework/web/reactive/result/method/annotation/RequestMappingVersionIntegrationTests.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ void deprecation(HttpServer httpServer) throws Exception {
7474

7575
private ResponseEntity<String> exchangeWithVersion(String version) {
7676
String url = "http://localhost:" + this.port;
77-
RequestEntity<Void> requestEntity = RequestEntity.get(url).header("X-API-Version", version).build();
77+
RequestEntity<Void> requestEntity = RequestEntity.get(url).header("API-Version", version).build();
7878
return getRestTemplate().exchange(requestEntity, String.class);
7979
}
8080

@@ -88,7 +88,7 @@ public void configureApiVersioning(ApiVersionConfigurer configurer) {
8888
StandardApiVersionDeprecationHandler handler = new StandardApiVersionDeprecationHandler();
8989
handler.configureVersion("1").setDeprecationLink(URI.create("https://example.org/deprecation"));
9090

91-
configurer.useRequestHeader("X-API-Version")
91+
configurer.useRequestHeader("API-Version")
9292
.addSupportedVersions("1", "1.1", "1.3", "1.6")
9393
.setDeprecationHandler(handler);
9494
}

0 commit comments

Comments
 (0)