Docs: Document required dependency for JsonToGrpc filter#4152
Docs: Document required dependency for JsonToGrpc filter#4152Ava051213 wants to merge 1 commit intospring-cloud:mainfrom
Conversation
de0f5e8 to
47aa582
Compare
There was a problem hiding this comment.
Pull request overview
This PR updates the Spring Cloud Gateway documentation to clarify the additional Jackson module required to use the JsonToGrpc GatewayFilter, preventing runtime NoClassDefFoundError due to a missing Protobuf JsonFactory.
Changes:
- Add a “Required Dependencies” section to the
JsonToGrpcfilter documentation. - Document the
com.fasterxml.jackson.dataformat:jackson-dataformat-protobufdependency needed for JSON↔gRPC conversion.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| === Required Dependencies | ||
|
|
||
| To use the `JsonToGrpc` filter, add the following dependencies: |
There was a problem hiding this comment.
This sentence refers to “dependencies” but only a single dependency is listed below. Update the wording to “dependency” to match the example.
| === Required Dependencies | |
| To use the `JsonToGrpc` filter, add the following dependencies: | |
| === Required Dependency | |
| To use the `JsonToGrpc` filter, add the following dependency: |
| @@ -22,6 +22,18 @@ src/main/resources/proto/hello.proto | |||
|
|
|||
| NOTE: `streaming` is not supported. | |||
|
|
|||
| === Required Dependencies | |||
There was a problem hiding this comment.
The section title is using a level-3 heading (===) even though this page doesn’t define any level-2 sections (==). That will nest this content oddly in the rendered docs/TOC. Use a level-2 heading (== Required Dependencies) instead (consistent with other GatewayFilter factory pages which don’t use === headings).
| === Required Dependencies | |
| == Required Dependencies |
…-cloud#3424 Signed-off-by: Mia051213 <3424808832@qq.com>
47aa582 to
2a37011
Compare
What does this PR do?
Documents the required
jackson-dataformat-protobufdependency for theJsonToGrpc filter.
Why is it needed?
Without this dependency, users get a
NoClassDefFoundErrorwhen using theJsonToGrpc filter.
Fixes #3424