diff --git a/multi/multi__actuator_api.html b/multi/multi__actuator_api.html index 97976221..b85a2b3d 100644 --- a/multi/multi__actuator_api.html +++ b/multi/multi__actuator_api.html @@ -1,3 +1,3 @@ - 11. Actuator API
11. Actuator API
Prev   Next

11. Actuator API

TODO: document the /gateway actuator endpoint

Prev   Next
10. CORS Configuration Home 12. Developer Guide
\ No newline at end of file + 11. Actuator API
11. Actuator API
Prev   Next

11. Actuator API

TODO: document the /gateway actuator endpoint

Prev   Next
10. CORS Configuration Home 12. Developer Guide
\ No newline at end of file diff --git a/multi/multi__building_a_simple_gateway_using_spring_mvc_or_webflux.html b/multi/multi__building_a_simple_gateway_using_spring_mvc_or_webflux.html index 4c01dd4c..16a6993c 100644 --- a/multi/multi__building_a_simple_gateway_using_spring_mvc_or_webflux.html +++ b/multi/multi__building_a_simple_gateway_using_spring_mvc_or_webflux.html @@ -1,6 +1,6 @@ - 13. Building a Simple Gateway Using Spring MVC or Webflux
13. Building a Simple Gateway Using Spring MVC or Webflux
Prev   

13. Building a Simple Gateway Using Spring MVC or Webflux

Spring Cloud Gateway provides a utility object called ProxyExchange which you can use inside a regular Spring web handler as a method parameter. It supports basic downstream HTTP exchanges via methods that mirror the HTTP verbs. With MVC it also supports forwarding to a local handler via the forward() method. To use the ProxyExchange just include the right module in your classpath (either spring-cloud-gateway-mvc or spring-cloud-gateway-webflux).

MVC example (proxying a request to "/test" downstream to a remote server):

@RestController
+   13. Building a Simple Gateway Using Spring MVC or Webflux
13. Building a Simple Gateway Using Spring MVC or Webflux
Prev   
13. Building a Simple Gateway Using Spring MVC or Webflux
Spring Cloud Gateway provides a utility object called ProxyExchange which you can use inside a regular Spring web handler as a method parameter. It supports basic downstream HTTP exchanges via methods that mirror the HTTP verbs. With MVC it also supports forwarding to a local handler via the forward() method. To use the ProxyExchange just include the right module in your classpath (either spring-cloud-gateway-mvc or spring-cloud-gateway-webflux).
MVC example (proxying a request to "/test" downstream to a remote server):
@RestController
 @SpringBootApplication
 public class GatewaySampleApplication {
 
diff --git a/multi/multi__configuration.html b/multi/multi__configuration.html
index 0e959ab4..76786fb1 100644
--- a/multi/multi__configuration.html
+++ b/multi/multi__configuration.html
@@ -1,6 +1,6 @@
 
       
-   8. Configuration
8. Configuration
Prev   Next
8. Configuration
Configuration for Spring Cloud Gateway is driven by a collection of `RouteDefinitionLocator`s.
RouteDefinitionLocator.java. 
+   8. Configuration
8. Configuration
Prev   Next
8. Configuration
Configuration for Spring Cloud Gateway is driven by a collection of `RouteDefinitionLocator`s.
RouteDefinitionLocator.java. 
 
public interface RouteDefinitionLocator {
 	Flux<RouteDefinition> getRouteDefinitions();
 }

diff --git a/multi/multi__cors_configuration.html b/multi/multi__cors_configuration.html
index a2a4c793..d1149876 100644
--- a/multi/multi__cors_configuration.html
+++ b/multi/multi__cors_configuration.html
@@ -1,6 +1,6 @@
 
       
-   10. CORS Configuration
10. CORS Configuration
Prev   Next
10. CORS Configuration
The gateway can be configured to control CORS behavior. The "global" CORS configuration is a map of URL patterns to Spring Framework CorsConfiguration.
application.yml. 
+   10. CORS Configuration
10. CORS Configuration
Prev   Next
10. CORS Configuration
The gateway can be configured to control CORS behavior. The "global" CORS configuration is a map of URL patterns to Spring Framework CorsConfiguration.
application.yml. 
 
spring:
   cloud:
     gateway:
diff --git a/multi/multi__developer_guide.html b/multi/multi__developer_guide.html
index 0088571c..a74364be 100644
--- a/multi/multi__developer_guide.html
+++ b/multi/multi__developer_guide.html
@@ -1,6 +1,6 @@
 
       
-   12. Developer Guide
12. Developer Guide
Prev   Next
12. Developer Guide
TODO: overview of writing custom integrations
12.1 Writing Custom Route Predicate Factories
TODO: document writing Custom Route Predicate Factories
12.2 Writing Custom GatewayFilter Factories
In order to write a GatewayFilter you will need to implement GatewayFilterFactory.  There is an abstract class called AbstractGatewayFilterFactory which you can extend.
PreGatewayFilterFactory.java. 
+   12. Developer Guide
12. Developer Guide
Prev   Next
12. Developer Guide
TODO: overview of writing custom integrations
12.1 Writing Custom Route Predicate Factories
TODO: document writing Custom Route Predicate Factories
12.2 Writing Custom GatewayFilter Factories
In order to write a GatewayFilter you will need to implement GatewayFilterFactory.  There is an abstract class called AbstractGatewayFilterFactory which you can extend.
PreGatewayFilterFactory.java. 
 
public class PreGatewayFilterFactory extends AbstractGatewayFilterFactory<PreGatewayFilterFactory.Config> {
 
 	public PreGatewayFilterFactory() {
diff --git a/multi/multi__gatewayfilter_factories.html b/multi/multi__gatewayfilter_factories.html
index 442473d0..0377c5a5 100644
--- a/multi/multi__gatewayfilter_factories.html
+++ b/multi/multi__gatewayfilter_factories.html
@@ -1,6 +1,6 @@
 
       
-   5. GatewayFilter Factories
5. GatewayFilter Factories
Prev   Next
5. GatewayFilter Factories
Route filters allow the modification of the incoming HTTP request or outgoing HTTP response in some manner. Route filters are scoped to a particular route. Spring Cloud Gateway includes many built-in GatewayFilter Factories.
NOTE For more detailed examples on how to use any of the following filters, take a look at the unit tests.
5.1 AddRequestHeader GatewayFilter Factory
The AddRequestHeader GatewayFilter Factory takes a name and value parameter.
application.yml. 
+   5. GatewayFilter Factories
5. GatewayFilter Factories
Prev   Next
5. GatewayFilter Factories
Route filters allow the modification of the incoming HTTP request or outgoing HTTP response in some manner. Route filters are scoped to a particular route. Spring Cloud Gateway includes many built-in GatewayFilter Factories.
NOTE For more detailed examples on how to use any of the following filters, take a look at the unit tests.
5.1 AddRequestHeader GatewayFilter Factory
The AddRequestHeader GatewayFilter Factory takes a name and value parameter.
application.yml. 
 
spring:
   cloud:
     gateway:
diff --git a/multi/multi__global_filters.html b/multi/multi__global_filters.html
index 3fceb368..e692c43c 100644
--- a/multi/multi__global_filters.html
+++ b/multi/multi__global_filters.html
@@ -1,6 +1,6 @@
 
       
-   6. Global Filters
6. Global Filters
Prev   Next
6. Global Filters
The GlobalFilter interface has the same signature as GatewayFilter. These are special filters that are conditionally applied to all routes. (This interface and usage are subject to change in future milestones).
6.1 Combined Global Filter and GatewayFilter Ordering
When a request comes in (and matches a Route) the Filtering Web Handler will add all instances of GlobalFilter and all route specific instances of GatewayFilter to a filter chain. This combined filter chain is sorted by the org.springframework.core.Ordered interface, which can be set by implementing the getOrder() method or by using the @Order annotation.
As Spring Cloud Gateway distinguishes between "pre" and "post" phases for filter logic execution (see: How It Works), the filter with the highest precedence will be the first in the "pre"-phase and the last in the "post"-phase.
ExampleConfiguration.java. 
+   6. Global Filters
6. Global Filters
Prev   Next
6. Global Filters
The GlobalFilter interface has the same signature as GatewayFilter. These are special filters that are conditionally applied to all routes. (This interface and usage are subject to change in future milestones).
6.1 Combined Global Filter and GatewayFilter Ordering
When a request comes in (and matches a Route) the Filtering Web Handler will add all instances of GlobalFilter and all route specific instances of GatewayFilter to a filter chain. This combined filter chain is sorted by the org.springframework.core.Ordered interface, which can be set by implementing the getOrder() method or by using the @Order annotation.
As Spring Cloud Gateway distinguishes between "pre" and "post" phases for filter logic execution (see: How It Works), the filter with the highest precedence will be the first in the "pre"-phase and the last in the "post"-phase.
ExampleConfiguration.java. 
 
@Bean
 @Order(-1)
 public GlobalFilter a() {
diff --git a/multi/multi__glossary.html b/multi/multi__glossary.html
index b2452c6f..5e16e3f2 100644
--- a/multi/multi__glossary.html
+++ b/multi/multi__glossary.html
@@ -1,3 +1,3 @@
 
       
-   2. Glossary
2. Glossary
Prev   Next
2. Glossary
  • Route: Route the basic building block of the gateway. It is defined by an ID, a destination URI, a collection of predicates and a collection of filters. A route is matched if aggregate predicate is true.
  • Predicate: This is a Java 8 Function Predicate. The input type is a Spring Framework ServerWebExchange. This allows developers to match on anything from the HTTP request, such as headers or parameters.
  • Filter: These are instances Spring Framework GatewayFilter constructed in with a specific factory. Here, requests and responses can be modified before or after sending the downstream request.
Prev   Next
1. How to Include Spring Cloud Gateway Home 3. How It Works

\ No newline at end of file
+   2. Glossary
2. Glossary
Prev   Next
2. Glossary
  • Route: Route the basic building block of the gateway. It is defined by an ID, a destination URI, a collection of predicates and a collection of filters. A route is matched if aggregate predicate is true.
  • Predicate: This is a Java 8 Function Predicate. The input type is a Spring Framework ServerWebExchange. This allows developers to match on anything from the HTTP request, such as headers or parameters.
  • Filter: These are instances Spring Framework GatewayFilter constructed in with a specific factory. Here, requests and responses can be modified before or after sending the downstream request.
Prev   Next
1. How to Include Spring Cloud Gateway Home 3. How It Works

\ No newline at end of file
diff --git a/multi/multi__reactor_netty_access_logs.html b/multi/multi__reactor_netty_access_logs.html
index b37d74a2..5c5352da 100644
--- a/multi/multi__reactor_netty_access_logs.html
+++ b/multi/multi__reactor_netty_access_logs.html
@@ -1,6 +1,6 @@
 
       
-   9. Reactor Netty Access Logs
9. Reactor Netty Access Logs
Prev   Next
9. Reactor Netty Access Logs
To enable Reactor Netty access logs, set -Dreactor.netty.http.server.accessLogEnabled=true. (It must be a Java System Property, not a Spring Boot property).
The logging system can be configured to have a separate access log file. Below is an example logback configuration:
logback.xml. 
+   9. Reactor Netty Access Logs
9. Reactor Netty Access Logs
Prev   Next
9. Reactor Netty Access Logs
To enable Reactor Netty access logs, set -Dreactor.netty.http.server.accessLogEnabled=true. (It must be a Java System Property, not a Spring Boot property).
The logging system can be configured to have a separate access log file. Below is an example logback configuration:
logback.xml. 
 
    <appender name="accessLog" class="ch.qos.logback.core.FileAppender">
         <file>access_log.log</file>
         <encoder>
diff --git a/multi/multi__tls_ssl.html b/multi/multi__tls_ssl.html
index 79f9863d..1350b0b8 100644
--- a/multi/multi__tls_ssl.html
+++ b/multi/multi__tls_ssl.html
@@ -1,6 +1,6 @@
 
       
-   7. TLS / SSL
7. TLS / SSL
Prev   Next
7. TLS / SSL
The Gateway can listen for requests on https by following the usual Spring server configuration. Example:
application.yml. 
+   7. TLS / SSL
7. TLS / SSL
Prev   Next
7. TLS / SSL
The Gateway can listen for requests on https by following the usual Spring server configuration. Example:
application.yml. 
 
server:
   ssl:
     enabled: true
diff --git a/multi/multi_gateway-how-it-works.html b/multi/multi_gateway-how-it-works.html
index e3c38c28..36355098 100644
--- a/multi/multi_gateway-how-it-works.html
+++ b/multi/multi_gateway-how-it-works.html
@@ -1,3 +1,3 @@
 
       
-   3. How It Works
3. How It Works
Prev   Next
3. How It Works
Spring Cloud Gateway Diagram
Clients make requests to Spring Cloud Gateway. If the Gateway Handler Mapping determines that a request matches a Route, it is sent to the Gateway Web Handler. This handler runs sends the request through a filter chain that is specific to the request. The reason the filters are divided by the dotted line, is that filters may execute logic before the proxy request is sent or after. All "pre" filter logic is executed, then the proxy request is made. After the proxy request is made, the "post" filter logic is executed.
[Note]Note
URIs defined in routes without a port will get a default port set to 80 and 443 for HTTP and HTTPS URIs respectively.
Prev   Next
2. Glossary Home 4. Route Predicate Factories

\ No newline at end of file
+   3. How It Works
3. How It Works
Prev   Next
3. How It Works
Spring Cloud Gateway Diagram
Clients make requests to Spring Cloud Gateway. If the Gateway Handler Mapping determines that a request matches a Route, it is sent to the Gateway Web Handler. This handler runs sends the request through a filter chain that is specific to the request. The reason the filters are divided by the dotted line, is that filters may execute logic before the proxy request is sent or after. All "pre" filter logic is executed, then the proxy request is made. After the proxy request is made, the "post" filter logic is executed.
[Note]Note
URIs defined in routes without a port will get a default port set to 80 and 443 for HTTP and HTTPS URIs respectively.
Prev   Next
2. Glossary Home 4. Route Predicate Factories

\ No newline at end of file
diff --git a/multi/multi_gateway-request-predicates-factories.html b/multi/multi_gateway-request-predicates-factories.html
index 03d1ecd3..c1b57fab 100644
--- a/multi/multi_gateway-request-predicates-factories.html
+++ b/multi/multi_gateway-request-predicates-factories.html
@@ -1,6 +1,6 @@
 
       
-   4. Route Predicate Factories
4. Route Predicate Factories
Prev   Next
4. Route Predicate Factories
Spring Cloud Gateway matches routes as part of the Spring WebFlux HandlerMapping infrastructure. Spring Cloud Gateway includes many built-in Route Predicate Factories. All of these predicates match on different attributes of the HTTP request. Multiple Route Predicate Factories can be combined and are combined via logical and.
4.1 After Route Predicate Factory
The After Route Predicate Factory takes one parameter, a datetime. This predicate matches requests that happen after the current datetime.
application.yml. 
+   4. Route Predicate Factories
4. Route Predicate Factories
Prev   Next
4. Route Predicate Factories
Spring Cloud Gateway matches routes as part of the Spring WebFlux HandlerMapping infrastructure. Spring Cloud Gateway includes many built-in Route Predicate Factories. All of these predicates match on different attributes of the HTTP request. Multiple Route Predicate Factories can be combined and are combined via logical and.
4.1 After Route Predicate Factory
The After Route Predicate Factory takes one parameter, a datetime. This predicate matches requests that happen after the current datetime.
application.yml. 
 
spring:
   cloud:
     gateway:
@@ -104,7 +104,7 @@ This may not match the actual client IP address if Spring Cloud Gateway sits beh
 Spring Cloud Gateway comes with one non-default remote address resolver which is based off of the X-Forwarded-For header, XForwardedRemoteAddressResolver.
XForwardedRemoteAddressResolver has two static constructor methods which take different approaches to security:
XForwardedRemoteAddressResolver::trustAll returns a RemoteAddressResolver which always takes the first IP address found in the X-Forwarded-For header.
 This approach is vulnerable to spoofing, as a malicious client could set an initial value for the X-Forwarded-For which would be accepted by the resolver.
XForwardedRemoteAddressResolver::maxTrustedIndex takes an index which correlates to the number of trusted infrastructure running in front of Spring Cloud Gateway.
 If Spring Cloud Gateway is, for example only accessible via HAProxy, then a value of 1 should be used.
-If two hops of trusted infrastructure are required before Spring Cloud Gateway is accessible, then a value of 2 should be used.
Given the following header value:
X-Forwarded-For: 0.0.0.1, 0.0.0.2, 0.0.0.3
The maxTrustedIndex values below will yield the following remote addresses.
maxTrustedIndexresult
[Integer.MIN_VALUE,0]
(invalid, IllegalArgumentException during initialization)
1
0.0.0.3
2
0.0.0.2
3
0.0.0.1
[4, Integer.MAX_VALUE]
0.0.0.1
Using Java config:
GatewayConfig.java
RemoteAddressResolver resolver = XForwardedRemoteAddressResolver
+If two hops of trusted infrastructure are required before Spring Cloud Gateway is accessible, then a value of 2 should be used.
Given the following header value:
X-Forwarded-For: 0.0.0.1, 0.0.0.2, 0.0.0.3
The maxTrustedIndex values below will yield the following remote addresses.
maxTrustedIndexresult
[Integer.MIN_VALUE,0]
(invalid, IllegalArgumentException during initialization)
1
0.0.0.3
2
0.0.0.2
3
0.0.0.1
[4, Integer.MAX_VALUE]
0.0.0.1
Using Java config:
GatewayConfig.java
RemoteAddressResolver resolver = XForwardedRemoteAddressResolver
     .maxTrustedIndex(1);
 
 ...
diff --git a/multi/multi_gateway-starter.html b/multi/multi_gateway-starter.html
index a179348b..b5cb33cf 100644
--- a/multi/multi_gateway-starter.html
+++ b/multi/multi_gateway-starter.html
@@ -1,5 +1,5 @@
 
       
-   1. How to Include Spring Cloud Gateway
1. How to Include Spring Cloud Gateway
Prev   Next
1. How to Include Spring Cloud Gateway
To include Spring Cloud Gateway in your project use the starter with group org.springframework.cloud
+   1. How to Include Spring Cloud Gateway
1. How to Include Spring Cloud Gateway
Prev   Next
1. How to Include Spring Cloud Gateway
To include Spring Cloud Gateway in your project use the starter with group org.springframework.cloud
 and artifact id spring-cloud-starter-gateway. See the Spring Cloud Project page
 for details on setting up your build system with the current Spring Cloud Release Train.
If you include the starter, but, for some reason, you do not want the gateway to be enabled, set spring.cloud.gateway.enabled=false.
[Important]Important
Spring Cloud Gateway requires the Netty runtime provided by Spring Boot and Spring Webflux. It does not work in a traditional Servlet Container or built as a WAR.
Prev   Next
 Home 2. Glossary

\ No newline at end of file
diff --git a/multi/multi_pr01.html b/multi/multi_pr01.html
index 0efb3a19..3d6a8ee3 100644
--- a/multi/multi_pr01.html
+++ b/multi/multi_pr01.html
@@ -1,3 +1,3 @@
 
       
-   
Prev   Next
2.1.0.BUILD-SNAPSHOT
This project provides an API Gateway built on top of the Spring Ecosystem, including: Spring 5, Spring Boot 2 and Project Reactor. Spring Cloud Gateway aims to provide a simple, yet effective way to route to APIs and provide cross cutting concerns to them such as: security, monitoring/metrics, and resiliency.
Prev   Next
Spring Cloud Gateway Home 1. How to Include Spring Cloud Gateway

\ No newline at end of file
+   
Prev   Next
2.1.0.BUILD-SNAPSHOT
This project provides an API Gateway built on top of the Spring Ecosystem, including: Spring 5, Spring Boot 2 and Project Reactor. Spring Cloud Gateway aims to provide a simple, yet effective way to route to APIs and provide cross cutting concerns to them such as: security, monitoring/metrics, and resiliency.
Prev   Next
Spring Cloud Gateway Home 1. How to Include Spring Cloud Gateway

\ No newline at end of file
diff --git a/multi/multi_spring-cloud-gateway.html b/multi/multi_spring-cloud-gateway.html
index 221b0a5f..33a8c485 100644
--- a/multi/multi_spring-cloud-gateway.html
+++ b/multi/multi_spring-cloud-gateway.html
@@ -1,3 +1,3 @@
 
       
-   Spring Cloud Gateway
Spring Cloud Gateway
   Next
Spring Cloud Gateway
Table of Contents
1. How to Include Spring Cloud Gateway
2. Glossary
3. How It Works
4. Route Predicate Factories
4.1. After Route Predicate Factory
4.2. Before Route Predicate Factory
4.3. Between Route Predicate Factory
4.4. Cookie Route Predicate Factory
4.5. Header Route Predicate Factory
4.6. Host Route Predicate Factory
4.7. Method Route Predicate Factory
4.8. Path Route Predicate Factory
4.9. Query Route Predicate Factory
4.10. RemoteAddr Route Predicate Factory
4.10.1. Modifying the way remote addresses are resolved
5. GatewayFilter Factories
5.1. AddRequestHeader GatewayFilter Factory
5.2. AddRequestParameter GatewayFilter Factory
5.3. AddResponseHeader GatewayFilter Factory
5.4. Hystrix GatewayFilter Factory
5.5. PrefixPath GatewayFilter Factory
5.6. PreserveHostHeader GatewayFilter Factory
5.7. RequestRateLimiter GatewayFilter Factory
5.7.1. Redis RateLimiter
5.8. RedirectTo GatewayFilter Factory
5.9. RemoveNonProxyHeaders GatewayFilter Factory
5.10. RemoveRequestHeader GatewayFilter Factory
5.11. RemoveResponseHeader GatewayFilter Factory
5.12. RewritePath GatewayFilter Factory
5.13. SaveSession GatewayFilter Factory
5.14. SecureHeaders GatewayFilter Factory
5.15. SetPath GatewayFilter Factory
5.16. SetResponseHeader GatewayFilter Factory
5.17. SetStatus GatewayFilter Factory
5.18. StripPrefix GatewayFilter Factory
5.19. Retry GatewayFilter Factory
5.20. RequestSize GatewayFilter Factory
6. Global Filters
6.1. Combined Global Filter and GatewayFilter Ordering
6.2. Forward Routing Filter
6.3. LoadBalancerClient Filter
6.4. Netty Routing Filter
6.5. Netty Write Response Filter
6.6. RouteToRequestUrl Filter
6.7. Websocket Routing Filter
6.8. Gateway Metrics Filter
6.9. Making An Exchange As Routed
7. TLS / SSL
8. Configuration
8.1. Fluent Java Routes API
8.2. DiscoveryClient Route Definition Locator
9. Reactor Netty Access Logs
10. CORS Configuration
11. Actuator API
12. Developer Guide
12.1. Writing Custom Route Predicate Factories
12.2. Writing Custom GatewayFilter Factories
12.3. Writing Custom Global Filters
12.4. Writing Custom Route Locators and Writers
13. Building a Simple Gateway Using Spring MVC or Webflux
   Next
   

\ No newline at end of file
+   Spring Cloud Gateway
Spring Cloud Gateway
   Next
Spring Cloud Gateway
Table of Contents
1. How to Include Spring Cloud Gateway
2. Glossary
3. How It Works
4. Route Predicate Factories
4.1. After Route Predicate Factory
4.2. Before Route Predicate Factory
4.3. Between Route Predicate Factory
4.4. Cookie Route Predicate Factory
4.5. Header Route Predicate Factory
4.6. Host Route Predicate Factory
4.7. Method Route Predicate Factory
4.8. Path Route Predicate Factory
4.9. Query Route Predicate Factory
4.10. RemoteAddr Route Predicate Factory
4.10.1. Modifying the way remote addresses are resolved
5. GatewayFilter Factories
5.1. AddRequestHeader GatewayFilter Factory
5.2. AddRequestParameter GatewayFilter Factory
5.3. AddResponseHeader GatewayFilter Factory
5.4. Hystrix GatewayFilter Factory
5.5. PrefixPath GatewayFilter Factory
5.6. PreserveHostHeader GatewayFilter Factory
5.7. RequestRateLimiter GatewayFilter Factory
5.7.1. Redis RateLimiter
5.8. RedirectTo GatewayFilter Factory
5.9. RemoveNonProxyHeaders GatewayFilter Factory
5.10. RemoveRequestHeader GatewayFilter Factory
5.11. RemoveResponseHeader GatewayFilter Factory
5.12. RewritePath GatewayFilter Factory
5.13. SaveSession GatewayFilter Factory
5.14. SecureHeaders GatewayFilter Factory
5.15. SetPath GatewayFilter Factory
5.16. SetResponseHeader GatewayFilter Factory
5.17. SetStatus GatewayFilter Factory
5.18. StripPrefix GatewayFilter Factory
5.19. Retry GatewayFilter Factory
5.20. RequestSize GatewayFilter Factory
6. Global Filters
6.1. Combined Global Filter and GatewayFilter Ordering
6.2. Forward Routing Filter
6.3. LoadBalancerClient Filter
6.4. Netty Routing Filter
6.5. Netty Write Response Filter
6.6. RouteToRequestUrl Filter
6.7. Websocket Routing Filter
6.8. Gateway Metrics Filter
6.9. Making An Exchange As Routed
7. TLS / SSL
8. Configuration
8.1. Fluent Java Routes API
8.2. DiscoveryClient Route Definition Locator
9. Reactor Netty Access Logs
10. CORS Configuration
11. Actuator API
12. Developer Guide
12.1. Writing Custom Route Predicate Factories
12.2. Writing Custom GatewayFilter Factories
12.3. Writing Custom Global Filters
12.4. Writing Custom Route Locators and Writers
13. Building a Simple Gateway Using Spring MVC or Webflux
   Next
   

\ No newline at end of file
diff --git a/single/spring-cloud-gateway.html b/single/spring-cloud-gateway.html
index 553063b8..111647da 100644
--- a/single/spring-cloud-gateway.html
+++ b/single/spring-cloud-gateway.html
@@ -1,6 +1,6 @@
 
       
-   Spring Cloud Gateway
Spring Cloud Gateway
Table of Contents
1. How to Include Spring Cloud Gateway
2. Glossary
3. How It Works
4. Route Predicate Factories
4.1. After Route Predicate Factory
4.2. Before Route Predicate Factory
4.3. Between Route Predicate Factory
4.4. Cookie Route Predicate Factory
4.5. Header Route Predicate Factory
4.6. Host Route Predicate Factory
4.7. Method Route Predicate Factory
4.8. Path Route Predicate Factory
4.9. Query Route Predicate Factory
4.10. RemoteAddr Route Predicate Factory
4.10.1. Modifying the way remote addresses are resolved
5. GatewayFilter Factories
5.1. AddRequestHeader GatewayFilter Factory
5.2. AddRequestParameter GatewayFilter Factory
5.3. AddResponseHeader GatewayFilter Factory
5.4. Hystrix GatewayFilter Factory
5.5. PrefixPath GatewayFilter Factory
5.6. PreserveHostHeader GatewayFilter Factory
5.7. RequestRateLimiter GatewayFilter Factory
5.7.1. Redis RateLimiter
5.8. RedirectTo GatewayFilter Factory
5.9. RemoveNonProxyHeaders GatewayFilter Factory
5.10. RemoveRequestHeader GatewayFilter Factory
5.11. RemoveResponseHeader GatewayFilter Factory
5.12. RewritePath GatewayFilter Factory
5.13. SaveSession GatewayFilter Factory
5.14. SecureHeaders GatewayFilter Factory
5.15. SetPath GatewayFilter Factory
5.16. SetResponseHeader GatewayFilter Factory
5.17. SetStatus GatewayFilter Factory
5.18. StripPrefix GatewayFilter Factory
5.19. Retry GatewayFilter Factory
5.20. RequestSize GatewayFilter Factory
6. Global Filters
6.1. Combined Global Filter and GatewayFilter Ordering
6.2. Forward Routing Filter
6.3. LoadBalancerClient Filter
6.4. Netty Routing Filter
6.5. Netty Write Response Filter
6.6. RouteToRequestUrl Filter
6.7. Websocket Routing Filter
6.8. Gateway Metrics Filter
6.9. Making An Exchange As Routed
7. TLS / SSL
8. Configuration
8.1. Fluent Java Routes API
8.2. DiscoveryClient Route Definition Locator
9. Reactor Netty Access Logs
10. CORS Configuration
11. Actuator API
12. Developer Guide
12.1. Writing Custom Route Predicate Factories
12.2. Writing Custom GatewayFilter Factories
12.3. Writing Custom Global Filters
12.4. Writing Custom Route Locators and Writers
13. Building a Simple Gateway Using Spring MVC or Webflux
2.1.0.BUILD-SNAPSHOT
This project provides an API Gateway built on top of the Spring Ecosystem, including: Spring 5, Spring Boot 2 and Project Reactor. Spring Cloud Gateway aims to provide a simple, yet effective way to route to APIs and provide cross cutting concerns to them such as: security, monitoring/metrics, and resiliency.
1. How to Include Spring Cloud Gateway
To include Spring Cloud Gateway in your project use the starter with group org.springframework.cloud
+   Spring Cloud Gateway
Spring Cloud Gateway
Table of Contents
1. How to Include Spring Cloud Gateway
2. Glossary
3. How It Works
4. Route Predicate Factories
4.1. After Route Predicate Factory
4.2. Before Route Predicate Factory
4.3. Between Route Predicate Factory
4.4. Cookie Route Predicate Factory
4.5. Header Route Predicate Factory
4.6. Host Route Predicate Factory
4.7. Method Route Predicate Factory
4.8. Path Route Predicate Factory
4.9. Query Route Predicate Factory
4.10. RemoteAddr Route Predicate Factory
4.10.1. Modifying the way remote addresses are resolved
5. GatewayFilter Factories
5.1. AddRequestHeader GatewayFilter Factory
5.2. AddRequestParameter GatewayFilter Factory
5.3. AddResponseHeader GatewayFilter Factory
5.4. Hystrix GatewayFilter Factory
5.5. PrefixPath GatewayFilter Factory
5.6. PreserveHostHeader GatewayFilter Factory
5.7. RequestRateLimiter GatewayFilter Factory
5.7.1. Redis RateLimiter
5.8. RedirectTo GatewayFilter Factory
5.9. RemoveNonProxyHeaders GatewayFilter Factory
5.10. RemoveRequestHeader GatewayFilter Factory
5.11. RemoveResponseHeader GatewayFilter Factory
5.12. RewritePath GatewayFilter Factory
5.13. SaveSession GatewayFilter Factory
5.14. SecureHeaders GatewayFilter Factory
5.15. SetPath GatewayFilter Factory
5.16. SetResponseHeader GatewayFilter Factory
5.17. SetStatus GatewayFilter Factory
5.18. StripPrefix GatewayFilter Factory
5.19. Retry GatewayFilter Factory
5.20. RequestSize GatewayFilter Factory
6. Global Filters
6.1. Combined Global Filter and GatewayFilter Ordering
6.2. Forward Routing Filter
6.3. LoadBalancerClient Filter
6.4. Netty Routing Filter
6.5. Netty Write Response Filter
6.6. RouteToRequestUrl Filter
6.7. Websocket Routing Filter
6.8. Gateway Metrics Filter
6.9. Making An Exchange As Routed
7. TLS / SSL
8. Configuration
8.1. Fluent Java Routes API
8.2. DiscoveryClient Route Definition Locator
9. Reactor Netty Access Logs
10. CORS Configuration
11. Actuator API
12. Developer Guide
12.1. Writing Custom Route Predicate Factories
12.2. Writing Custom GatewayFilter Factories
12.3. Writing Custom Global Filters
12.4. Writing Custom Route Locators and Writers
13. Building a Simple Gateway Using Spring MVC or Webflux
2.1.0.BUILD-SNAPSHOT
This project provides an API Gateway built on top of the Spring Ecosystem, including: Spring 5, Spring Boot 2 and Project Reactor. Spring Cloud Gateway aims to provide a simple, yet effective way to route to APIs and provide cross cutting concerns to them such as: security, monitoring/metrics, and resiliency.
1. How to Include Spring Cloud Gateway
To include Spring Cloud Gateway in your project use the starter with group org.springframework.cloud
 and artifact id spring-cloud-starter-gateway. See the Spring Cloud Project page
 for details on setting up your build system with the current Spring Cloud Release Train.
If you include the starter, but, for some reason, you do not want the gateway to be enabled, set spring.cloud.gateway.enabled=false.
[Important]Important
Spring Cloud Gateway requires the Netty runtime provided by Spring Boot and Spring Webflux. It does not work in a traditional Servlet Container or built as a WAR.
2. Glossary
  • Route: Route the basic building block of the gateway. It is defined by an ID, a destination URI, a collection of predicates and a collection of filters. A route is matched if aggregate predicate is true.
  • Predicate: This is a Java 8 Function Predicate. The input type is a Spring Framework ServerWebExchange. This allows developers to match on anything from the HTTP request, such as headers or parameters.
  • Filter: These are instances Spring Framework GatewayFilter constructed in with a specific factory. Here, requests and responses can be modified before or after sending the downstream request.
3. How It Works
Spring Cloud Gateway Diagram
Clients make requests to Spring Cloud Gateway. If the Gateway Handler Mapping determines that a request matches a Route, it is sent to the Gateway Web Handler. This handler runs sends the request through a filter chain that is specific to the request. The reason the filters are divided by the dotted line, is that filters may execute logic before the proxy request is sent or after. All "pre" filter logic is executed, then the proxy request is made. After the proxy request is made, the "post" filter logic is executed.
[Note]Note
URIs defined in routes without a port will get a default port set to 80 and 443 for HTTP and HTTPS URIs respectively.
4. Route Predicate Factories
Spring Cloud Gateway matches routes as part of the Spring WebFlux HandlerMapping infrastructure. Spring Cloud Gateway includes many built-in Route Predicate Factories. All of these predicates match on different attributes of the HTTP request. Multiple Route Predicate Factories can be combined and are combined via logical and.
4.1 After Route Predicate Factory
The After Route Predicate Factory takes one parameter, a datetime. This predicate matches requests that happen after the current datetime.
application.yml. 
 
spring:
@@ -106,7 +106,7 @@ This may not match the actual client IP address if Spring Cloud Gateway sits beh
 Spring Cloud Gateway comes with one non-default remote address resolver which is based off of the X-Forwarded-For header, XForwardedRemoteAddressResolver.
XForwardedRemoteAddressResolver has two static constructor methods which take different approaches to security:
XForwardedRemoteAddressResolver::trustAll returns a RemoteAddressResolver which always takes the first IP address found in the X-Forwarded-For header.
 This approach is vulnerable to spoofing, as a malicious client could set an initial value for the X-Forwarded-For which would be accepted by the resolver.
XForwardedRemoteAddressResolver::maxTrustedIndex takes an index which correlates to the number of trusted infrastructure running in front of Spring Cloud Gateway.
 If Spring Cloud Gateway is, for example only accessible via HAProxy, then a value of 1 should be used.
-If two hops of trusted infrastructure are required before Spring Cloud Gateway is accessible, then a value of 2 should be used.
Given the following header value:
X-Forwarded-For: 0.0.0.1, 0.0.0.2, 0.0.0.3
The maxTrustedIndex values below will yield the following remote addresses.
maxTrustedIndexresult
[Integer.MIN_VALUE,0]
(invalid, IllegalArgumentException during initialization)
1
0.0.0.3
2
0.0.0.2
3
0.0.0.1
[4, Integer.MAX_VALUE]
0.0.0.1
Using Java config:
GatewayConfig.java
RemoteAddressResolver resolver = XForwardedRemoteAddressResolver
+If two hops of trusted infrastructure are required before Spring Cloud Gateway is accessible, then a value of 2 should be used.
Given the following header value:
X-Forwarded-For: 0.0.0.1, 0.0.0.2, 0.0.0.3
The maxTrustedIndex values below will yield the following remote addresses.
maxTrustedIndexresult
[Integer.MIN_VALUE,0]
(invalid, IllegalArgumentException during initialization)
1
0.0.0.3
2
0.0.0.2
3
0.0.0.1
[4, Integer.MAX_VALUE]
0.0.0.1
Using Java config:
GatewayConfig.java
RemoteAddressResolver resolver = XForwardedRemoteAddressResolver
     .maxTrustedIndex(1);
 
 ...
diff --git a/spring-cloud-gateway.html b/spring-cloud-gateway.html
index 55c4bde6..5ef1fef5 100644
--- a/spring-cloud-gateway.html
+++ b/spring-cloud-gateway.html
@@ -4,7 +4,7 @@
 
 
 
-
+
 spring-cloud-gateway