API gateway library that routes matching requests through a request-specific filter chain.
Field note
Clients make requests to Spring Cloud Gateway. If the Gateway Handler Mapping determines a request matches a route, it is sent to the Gateway Web Handler, which runs it through a request-specific filter chain.
Capabilities
Tags
Ways to use it
java / org.springframework.cloud:spring-cloud-gateway
java / Not filed
Not filed / Not filed
java / org.springframework.cloud:spring-cloud-starter-gateway-server-webflux
Product features
GatewayFilter factory that adds a header to the incoming request.
Adds a header to the downstream request for all matching routes using name and value parameters.
Adds headers to downstream requests only if not already present, supporting multi-value headers and URI variables.
GatewayFilter that takes a name and value and adds them to the downstream request's query string for all matching requests.
Matches requests that happen after a specified ZonedDateTime.
Matches requests that happen before a specified ZonedDateTime.
Matches requests between two ZonedDateTime parameters.
Matches cookies by name whose values match a Java regular expression.
Route URIs without a port default to 80 for HTTP and 443 for HTTPS.
Set spring.cloud.gateway.enabled=false to disable the gateway.
GatewayFilter instances built from a factory that modify requests and responses.
Configure predicates and filters using name/args key-value pairs in YAML.
Apply filters to matched routes to modify requests and responses.
Determines whether a request matches a configured route.
Runs the request through a filter chain specific to the request.
Built-in factories that modify incoming HTTP requests or outgoing responses.
Matches a header whose value matches a Java regular expression.
Matches the Host header against Ant-style host name patterns.
Matches one or more HTTP methods such as GET or POST.
Requires the Netty runtime provided by Spring Boot and Spring WebFlux.
Matches Spring PathMatcher patterns with an optional matchTrailingSlash flag.
Filters can run logic both before and after the proxy request is sent.
Java 8 Function Predicate taking a ServerWebExchange to match on HTTP request parts.
Exclusively for annotation based WebFlux or Web MVC applications, using a special ProxyExchange object.
Basic building block defined by an ID, destination URI, predicates, and filters.
Match incoming requests to routes using configurable predicates such as Cookie.
Any path defined on a route URI is ignored.
Full-featured API gateway that can be standalone or embedded in a Spring Boot application.
Configure predicates and filters by name followed by comma-separated argument values.
WebFlux-based gateway server module for Spring Cloud Gateway.
AddRequestHeader is aware of URI variables and expands them at runtime.
Each flavor offers Web MVC compatibility.
Each flavor offers WebFlux compatibility.
Each flavor offers WebFlux and Web MVC compatibility.