AddRequestParameter Filter

The AddRequestParameter Filter takes a name and value parameter. The following example configures an AddRequestParameter filter:

application.yml

spring:
  cloud:
    gateway:
      mvc:
        routes:
        - id: add_request_parameter_route
          uri: https://example.org
          filters:
          - AddRequestParameter=red, blue
GatewaySampleApplication.java
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestParameter;
import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;

@Configuration
class RouteConfiguration {

    @Bean
    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeader() {
		return route("add_request_parameter_route")
				.GET("/anything/addrequestparam", http("https://example.org"))
					.before(addRequestParameter("red", "blue"))
					.build();
    }
}

This will add red=blue to the downstream request’s query string for all matching requests.

AddRequestParameter is aware of the URI variables used to match a path or host. URI variables may be used in the value and are expanded at runtime. The following example configures an AddRequestParameter filter that uses a variable:

GatewaySampleApplication.java
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestParameter;
import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
import static org.springframework.cloud.gateway.server.mvc.predicate.GatewayRequestPredicates.host;

@Configuration
class RouteConfiguration {

    @Bean
    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeader() {
		return route("add_request_parameter_route")
				.route(host("{segment}.myhost.org"), http("https://example.org"))
				.before(addRequestParameter("foo", "bar-{segment}"))
				.build();
    }
}