最新の安定バージョンについては、Spring Cloud Gateway 5.0.1 を使用してください!

AddRequestHeader フィルター

AddRequestHeader は、name および value パラメーターを取る「前」フィルターです。次の例では、AddRequestHeader フィルターを構成します。

application.yml
spring:
  cloud:
    gateway:
      mvc:
        routes:
        - id: add_request_header_route
          uri: https://example.org
          predicates:
          - Path=/red
          filters:
          - AddRequestHeader=X-Request-red, blue
GatewaySampleApplication.java
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestHeader;
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_header_route")
            .GET("/red", http())
            .before(uri("https://example.org"))
            .before(addRequestHeader("X-Request-red", "blue"));
    }
}

このリストは、一致するすべてのリクエストのダウンストリームリクエストのヘッダーに X-Request-red:blue ヘッダーを追加します。

AddRequestHeader は、パスまたはホストの照合に使用される URI 変数を認識します。URI 変数は値に使用でき、実行時に展開されます。次の例では、変数を使用する AddRequestHeader フィルターを構成します。

GatewaySampleApplication.java
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestHeader;
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_header_route")
            .GET("/red/{segment}", http())
            .before(uri("https://example.org"))
            .before(addRequestHeader("X-Request-red", "blue-{segment}"));
    }
}