diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 6d5866b8c..ac556a0d1 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -33,6 +33,7 @@ *** xref:spring-cloud-gateway/gatewayfilter-factories/requestratelimiter-factory.adoc[] *** xref:spring-cloud-gateway/gatewayfilter-factories/rewritelocationresponseheader-factory.adoc[] *** xref:spring-cloud-gateway/gatewayfilter-factories/rewritepath-factory.adoc[] +*** xref:spring-cloud-gateway/gatewayfilter-factories/rewriterequestparameter-factory.adoc[] *** xref:spring-cloud-gateway/gatewayfilter-factories/rewriteresponseheader-factory.adoc[] *** xref:spring-cloud-gateway/gatewayfilter-factories/savesession-factory.adoc[] *** xref:spring-cloud-gateway/gatewayfilter-factories/secureheaders-factory.adoc[] diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/rewriterequestparameter-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/rewriterequestparameter-factory.adoc new file mode 100644 index 000000000..cd980aad5 --- /dev/null +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/rewriterequestparameter-factory.adoc @@ -0,0 +1,26 @@ += `RewriteRequestParameter` `GatewayFilter` Factory + +The `RewriteRequestParameter` `GatewayFilter` factory takes a `name` parameter and a `replacement` parameter. +It will rewrite the value of the request parameter of the given `name`. +If multiple request parameters with the same `name` are set, they will be replaced with a single value. +If no request parameter is found, no changes will be made. +The following listing configures a `RewriteRequestParameter` `GatewayFilter`: + +.application.yml +==== +[source,yaml] +---- +spring: + cloud: + gateway: + routes: + - id: rewriterequestparameter_route + uri: https://example.org + predicates: + - Path=/products + filters: + - RewriteRequestParameter=campaign,fall2023 +---- +==== + +For a request to `/products?campaign=old`, this sets the request parameter to `campaign=fall2023`. \ No newline at end of file