Skip to content

Commit 2c08097

Browse files
authored
Merge pull request #4033 from ryanjbaxter/fix-mvc-docs-properties
Updated mvc docs with new properties
2 parents 6c52f38 + 1df540f commit 2c08097

32 files changed

+423
-378
lines changed

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/addrequestheader.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ The following example configures an `AddRequestHeader` filter:
1010
spring:
1111
cloud:
1212
gateway:
13-
mvc:
14-
routes:
15-
- id: add_request_header_route
16-
uri: https://example.org
17-
predicates:
18-
- Path=/red
19-
filters:
20-
- AddRequestHeader=X-Request-red, blue
13+
server:
14+
webmvc:
15+
routes:
16+
- id: add_request_header_route
17+
uri: https://example.org
18+
predicates:
19+
- Path=/red
20+
filters:
21+
- AddRequestHeader=X-Request-red, blue
2122
----
2223

2324
.GatewaySampleApplication.java

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/addrequestheadersifnotpresent.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ The following example configures an `AddRequestHeadersIfNotPresent` filter:
1010
spring:
1111
cloud:
1212
gateway:
13-
mvc:
14-
routes:
15-
- id: add_request_headers_route_inp
16-
uri: https://example.org
17-
predicates:
18-
- Path=/red
19-
filters:
20-
- AddRequestHeadersIfNotPresent=X-Request-Color-1:blue,X-Request-Color-2:green
13+
server:
14+
webmvc:
15+
routes:
16+
- id: add_request_headers_route_inp
17+
uri: https://example.org
18+
predicates:
19+
- Path=/red
20+
filters:
21+
- AddRequestHeadersIfNotPresent=X-Request-Color-1:blue,X-Request-Color-2:green
2122
----
2223

2324
.GatewaySampleApplication.java

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/addrequestparameter.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ application.yml
1010
spring:
1111
cloud:
1212
gateway:
13-
mvc:
14-
routes:
15-
- id: add_request_parameter_route
16-
uri: https://example.org
17-
predicates:
18-
- Path=/anything/addrequestparam
19-
filters:
20-
- AddRequestParameter=red, blue
13+
server:
14+
webmvc:
15+
routes:
16+
- id: add_request_parameter_route
17+
uri: https://example.org
18+
predicates:
19+
- Path=/anything/addrequestparam
20+
filters:
21+
- AddRequestParameter=red, blue
2122
----
2223

2324
.GatewaySampleApplication.java

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/addresponseheader.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ The following example configures an `AddResponseHeader` filter:
1010
spring:
1111
cloud:
1212
gateway:
13-
mvc:
14-
routes:
15-
- id: add_response_header_route
16-
uri: https://example.org
17-
predicates:
18-
- Path=/anything/addresheader
19-
filters:
20-
- AddResponseHeader=X-Response-Red, Blue
13+
server:
14+
webmvc:
15+
routes:
16+
- id: add_response_header_route
17+
uri: https://example.org
18+
predicates:
19+
- Path=/anything/addresheader
20+
filters:
21+
- AddResponseHeader=X-Response-Red, Blue
2122
----
2223

2324
.GatewaySampleApplication.java

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/circuitbreaker-filter.adoc

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ The following example configures a Spring Cloud CircuitBreaker filter:
1313
spring:
1414
cloud:
1515
gateway:
16-
mvc:
17-
routes:
18-
- id: circuitbreakernofallback
19-
uri: https://example.org
20-
predicates:
21-
- Path=/anything/circuitbreakernofallback
22-
filters:
23-
- CircuitBreaker=myCircuitBreaker
16+
server:
17+
webmvc:
18+
routes:
19+
- id: circuitbreakernofallback
20+
uri: https://example.org
21+
predicates:
22+
- Path=/anything/circuitbreakernofallback
23+
filters:
24+
- CircuitBreaker=myCircuitBreaker
2425
----
2526
.GatewaySampleApplication.java
2627
[source,java]
@@ -59,17 +60,18 @@ The following example configures such a fallback:
5960
spring:
6061
cloud:
6162
gateway:
62-
mvc:
63-
routes:
64-
- id: circuitbreaker_route
65-
uri: https://example.org
66-
predicates:
67-
- Path=/consumingServiceEndpoint
68-
filters:
69-
- name: CircuitBreaker
70-
args:
71-
name: myCircuitBreaker
72-
fallbackUri: forward:/inCaseOfFailureUseThis
63+
server:
64+
webmvc:
65+
routes:
66+
- id: circuitbreaker_route
67+
uri: https://example.org
68+
predicates:
69+
- Path=/consumingServiceEndpoint
70+
filters:
71+
- name: CircuitBreaker
72+
args:
73+
name: myCircuitBreaker
74+
fallbackUri: forward:/inCaseOfFailureUseThis
7375
----
7476

7577
The following listing does the same thing in Java:
@@ -182,20 +184,21 @@ value or the String representation of the `HttpStatus` enumeration.
182184
spring:
183185
cloud:
184186
gateway:
185-
mvc:
186-
routes:
187-
- id: circuitbreaker_route
188-
uri: lb://backing-service:8088
189-
predicates:
190-
- Path=/consumingServiceEndpoint
191-
filters:
192-
- name: CircuitBreaker
193-
args:
194-
name: myCircuitBreaker
195-
fallbackUri: forward:/inCaseOfFailureUseThis
196-
statusCodes:
197-
- 500
198-
- "NOT_FOUND"
187+
server:
188+
webmvc:
189+
routes:
190+
- id: circuitbreaker_route
191+
uri: lb://backing-service:8088
192+
predicates:
193+
- Path=/consumingServiceEndpoint
194+
filters:
195+
- name: CircuitBreaker
196+
args:
197+
name: myCircuitBreaker
198+
fallbackUri: forward:/inCaseOfFailureUseThis
199+
statusCodes:
200+
- 500
201+
- "NOT_FOUND"
199202
----
200203

201204
.GatewaySampleApplication.java

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/deduperesponseheader.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ The following example configures a `DedupeResponseHeader` filter:
1010
spring:
1111
cloud:
1212
gateway:
13-
mvc:
14-
routes:
15-
- id: dedupe_response_header_route
16-
uri: https://example.org
17-
predicates:
18-
- Path=/hello
19-
filters:
20-
- DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin
13+
server:
14+
webmvc:
15+
routes:
16+
- id: dedupe_response_header_route
17+
uri: https://example.org
18+
predicates:
19+
- Path=/hello
20+
filters:
21+
- DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin
2122
----
2223
.GatewaySampleApplication.java
2324
[source,java]

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/fallback-headers.adoc

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,26 @@ The `FallbackHeaders` factory lets you add Spring Cloud CircuitBreaker execution
99
spring:
1010
cloud:
1111
gateway:
12-
mvc:
13-
routes:
14-
- id: ingredients
15-
uri: lb://ingredients
16-
predicates:
17-
- Path=/ingredients/**
18-
filters:
19-
- name: CircuitBreaker
20-
args:
21-
name: fetchIngredients
22-
fallbackUri: forward:/fallback
23-
- id: ingredients-fallback
24-
uri: http://localhost:9994
25-
predicates:
26-
- Path=/fallback
27-
filters:
28-
- name: FallbackHeaders
29-
args:
30-
executionExceptionTypeHeaderName: Test-Header
12+
server:
13+
webmvc:
14+
routes:
15+
- id: ingredients
16+
uri: lb://ingredients
17+
predicates:
18+
- Path=/ingredients/**
19+
filters:
20+
- name: CircuitBreaker
21+
args:
22+
name: fetchIngredients
23+
fallbackUri: forward:/fallback
24+
- id: ingredients-fallback
25+
uri: http://localhost:9994
26+
predicates:
27+
- Path=/fallback
28+
filters:
29+
- name: FallbackHeaders
30+
args:
31+
executionExceptionTypeHeaderName: Test-Header
3132
----
3233

3334
.GatewaySampleApplication.java

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/loadbalancer.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,13 @@ The following listing configures a LoadBalancer Filter:
3535
spring:
3636
cloud:
3737
gateway:
38-
mvc:
39-
routes:
40-
- id: api_route
41-
uri: lb://apiservice
42-
predicates:
43-
- Path=/api/**
38+
server:
39+
webmvc:
40+
routes:
41+
- id: api_route
42+
uri: lb://apiservice
43+
predicates:
44+
- Path=/api/**
4445
----
4546

4647
WARNING: If using the `lb()` filter, it needs to be after any filter that manipulates the path such as `setPath()` or `stripPrefix()`, otherwise the resulting url could be incorrect. The `lb:` scheme handler in configuration, automatically puts the filter in the highest precedence order.

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/maprequestheader.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ The following example configures a `MapRequestHeader`:
1313
spring:
1414
cloud:
1515
gateway:
16-
mvc:
17-
routes:
18-
- id: map_request_header_route
19-
uri: https://example.org
20-
predicates:
21-
- Path=/mypath
22-
filters:
23-
- MapRequestHeader=Blue, X-Request-Red
16+
server:
17+
webmvc:
18+
routes:
19+
- id: map_request_header_route
20+
uri: https://example.org
21+
predicates:
22+
- Path=/mypath
23+
filters:
24+
- MapRequestHeader=Blue, X-Request-Red
2425
----
2526

2627
.GatewaySampleApplication.java

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/prefixpath.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ The following example configures a `PrefixPath` filter:
1111
spring:
1212
cloud:
1313
gateway:
14-
mvc:
15-
routes:
16-
- id: prefixpath_route
17-
uri: https://example.org
18-
predicates:
19-
- Path=/**
20-
filters:
21-
- PrefixPath=/mypath
14+
server:
15+
webmvc:
16+
routes:
17+
- id: prefixpath_route
18+
uri: https://example.org
19+
predicates:
20+
- Path=/**
21+
filters:
22+
- PrefixPath=/mypath
2223
----
2324

2425
.GatewaySampleApplication.java

0 commit comments

Comments
 (0)