GH-3791: Document AdaptCachedBody filter for Spring Cloud Gateway WebMVC#4197
Merged
ryanjbaxter merged 1 commit intoJun 15, 2026
Merged
Conversation
Add docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/adaptcachedbody.adoc explaining how to use the two-step body caching mechanism in Spring Cloud Gateway WebMVC: 1. MvcUtils.cacheAndReadBody() reads the InputStream once and stores the bytes as a request attribute 2. BeforeFilterFunctions.adaptCachedBody() wraps the request with a ByteArrayInputStream so downstream services can re-read the body Include a complete Java DSL example with callout annotations, and an IMPORTANT note that adaptCachedBody must be registered after the cache has been populated. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes GH-3791
BeforeFilterFunctions.adaptCachedBody()andMvcUtils.cacheAndReadBody()had no documentation. A user who needs to inspect the request body in a before filter (e.g., to verify an HMAC signature) and still forward the body to the downstream service had no documented path to implement this — requiring them to dig through source code and GitHub issues.Changes
docs/.../spring-cloud-gateway-server-webmvc/filters/adaptcachedbody.adocdocumenting:InputStreamcan only be read once)MvcUtils.cacheAndReadBody()thenadaptCachedBody()[IMPORTANT]note about ordering (cache must be populated beforeadaptCachedBodyruns)nav.adoc(alphabetically beforeaddrequestheader)Test plan
🤖 Generated with Claude Code