Skip to content

Commit dd4840b

Browse files
committed
Adds missing yaml config and fixes missing mvc key.
Fixes spring-cloudgh-3174
1 parent 7e0bbfe commit dd4840b

8 files changed

+126
-51
lines changed

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

+14
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44
The `AddRequestHeader` is a "before" filter that takes a `name` and `value` parameter.
55
The following example configures an `AddRequestHeader` filter:
66

7+
.application.yml
8+
[source,yaml]
9+
----
10+
spring:
11+
cloud:
12+
gateway:
13+
mvc:
14+
routes:
15+
- id: add_request_header_route
16+
uri: https://example.org
17+
filters:
18+
- AddRequestHeader=X-Request-red, blue
19+
----
20+
721
.GatewaySampleApplication.java
822
[source,java]
923
----

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

+14
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44
The `AddRequestHeadersIfNotPresent` filter takes a collection of `name` and `value` pairs separated by colon.
55
The following example configures an `AddRequestHeadersIfNotPresent` filter:
66

7+
.application.yml
8+
[source,yaml]
9+
----
10+
spring:
11+
cloud:
12+
gateway:
13+
mvc:
14+
routes:
15+
- id: add_request_headers_route
16+
uri: https://example.org
17+
filters:
18+
- AddRequestHeadersIfNotPresent=X-Request-Color-1:blue,X-Request-Color-2:green
19+
----
20+
721
.GatewaySampleApplication.java
822
[source,java]
923
----

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

+14
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44
The `AddRequestParameter` Filter takes a `name` and `value` parameter.
55
The following example configures an `AddRequestParameter` filter:
66

7+
application.yml
8+
[source,yaml]
9+
----
10+
spring:
11+
cloud:
12+
gateway:
13+
mvc:
14+
routes:
15+
- id: add_request_parameter_route
16+
uri: https://example.org
17+
filters:
18+
- AddRequestParameter=red, blue
19+
----
20+
721
.GatewaySampleApplication.java
822
[source,java]
923
----

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

+14
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44
The `AddResponseHeader` Filter takes a `name` and `value` parameter.
55
The following example configures an `AddResponseHeader` filter:
66

7+
.application.yml
8+
[source,yaml]
9+
----
10+
spring:
11+
cloud:
12+
gateway:
13+
mvc:
14+
routes:
15+
- id: add_response_header_route
16+
uri: https://example.org
17+
filters:
18+
- AddResponseHeader=X-Response-Red, Blue
19+
----
20+
721
.GatewaySampleApplication.java
822
[source,java]
923
----

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

+31-28
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ The following example configures a Spring Cloud CircuitBreaker filter:
1313
spring:
1414
cloud:
1515
gateway:
16-
routes:
17-
- id: circuitbreaker_route
18-
uri: https://example.org
19-
filters:
20-
- CircuitBreaker=myCircuitBreaker
16+
mvc:
17+
routes:
18+
- id: circuitbreaker_route
19+
uri: https://example.org
20+
filters:
21+
- CircuitBreaker=myCircuitBreaker
2122
----
2223
.GatewaySampleApplication.java
2324
[source,java]
@@ -54,16 +55,17 @@ The following example configures such a fallback:
5455
spring:
5556
cloud:
5657
gateway:
57-
routes:
58-
- id: circuitbreaker_route
59-
uri: https://example.org
60-
predicates:
61-
- Path=/consumingServiceEndpoint
62-
filters:
63-
- name: CircuitBreaker
64-
args:
65-
name: myCircuitBreaker
66-
fallbackUri: forward:/inCaseOfFailureUseThis
58+
mvc:
59+
routes:
60+
- id: circuitbreaker_route
61+
uri: https://example.org
62+
predicates:
63+
- Path=/consumingServiceEndpoint
64+
filters:
65+
- name: CircuitBreaker
66+
args:
67+
name: myCircuitBreaker
68+
fallbackUri: forward:/inCaseOfFailureUseThis
6769
----
6870

6971
The following listing does the same thing in Java:
@@ -170,19 +172,20 @@ value or the String representation of the `HttpStatus` enumeration.
170172
spring:
171173
cloud:
172174
gateway:
173-
routes:
174-
- id: circuitbreaker_route
175-
uri: lb://backing-service:8088
176-
predicates:
177-
- Path=/consumingServiceEndpoint
178-
filters:
179-
- name: CircuitBreaker
180-
args:
181-
name: myCircuitBreaker
182-
fallbackUri: forward:/inCaseOfFailureUseThis
183-
statusCodes:
184-
- 500
185-
- "NOT_FOUND"
175+
mvc:
176+
routes:
177+
- id: circuitbreaker_route
178+
uri: lb://backing-service:8088
179+
predicates:
180+
- Path=/consumingServiceEndpoint
181+
filters:
182+
- name: CircuitBreaker
183+
args:
184+
name: myCircuitBreaker
185+
fallbackUri: forward:/inCaseOfFailureUseThis
186+
statusCodes:
187+
- 500
188+
- "NOT_FOUND"
186189
----
187190

188191
.GatewaySampleApplication.java

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

+6-5
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ The following example configures a `DedupeResponseHeader` filter:
1010
spring:
1111
cloud:
1212
gateway:
13-
routes:
14-
- id: dedupe_response_header_route
15-
uri: https://example.org
16-
filters:
17-
- DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin
13+
mvc:
14+
routes:
15+
- id: dedupe_response_header_route
16+
uri: https://example.org
17+
filters:
18+
- DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin
1819
----
1920
.GatewaySampleApplication.java
2021
[source,java]

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

+19-18
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,25 @@ The `FallbackHeaders` factory lets you add Spring Cloud CircuitBreaker execution
99
spring:
1010
cloud:
1111
gateway:
12-
routes:
13-
- id: ingredients
14-
uri: lb://ingredients
15-
predicates:
16-
- Path=//ingredients/**
17-
filters:
18-
- name: CircuitBreaker
19-
args:
20-
name: fetchIngredients
21-
fallbackUri: forward:/fallback
22-
- id: ingredients-fallback
23-
uri: http://localhost:9994
24-
predicates:
25-
- Path=/fallback
26-
filters:
27-
- name: FallbackHeaders
28-
args:
29-
executionExceptionTypeHeaderName: Test-Header
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
3031
----
3132

3233
.GatewaySampleApplication.java

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

+14
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ If the input header does not exist, the filter has no impact.
77
If the new named header already exists, its values are augmented with the new values.
88
The following example configures a `MapRequestHeader`:
99

10+
.application.yml
11+
[source,yaml]
12+
----
13+
spring:
14+
cloud:
15+
gateway:
16+
mvc:
17+
routes:
18+
- id: map_request_header_route
19+
uri: https://example.org
20+
filters:
21+
- MapRequestHeader=Blue, X-Request-Red
22+
----
23+
1024
.GatewaySampleApplication.java
1125
[source,java]
1226
----

0 commit comments

Comments
 (0)