Skip to content

docs: document required dependencies for JsonToGrpc filter#4202

Open
won-seoop wants to merge 1 commit into
spring-cloud:mainfrom
won-seoop:doc-3424-jsontogrpc-dependencies
Open

docs: document required dependencies for JsonToGrpc filter#4202
won-seoop wants to merge 1 commit into
spring-cloud:mainfrom
won-seoop:doc-3424-jsontogrpc-dependencies

Conversation

@won-seoop

Copy link
Copy Markdown

Summary

Closes #3424

The JsonToGrpc GatewayFilter requires several optional libraries (jackson-dataformat-protobuf, grpc-netty, grpc-protobuf, grpc-stub, protobuf-java-util) that are not pulled in transitively by spring-cloud-starter-gateway. Without them users see a NoClassDefFoundError at runtime — confusing because the route is accepted at startup.

Added a [[jsontogrpc-dependencies]] section before the parameters list with:

  • Maven and Gradle snippets for all five dependencies (versions managed by the BOM)
  • A WARNING callout linking the symptom (NoClassDefFoundError) to the cause

Test plan

  • Docs build with Antora renders the new section without errors
  • Maven/Gradle snippets are syntactically correct

…oudGH-3424)

The JsonToGrpc filter depends on several optional libraries (jackson-dataformat-protobuf,
grpc-netty, grpc-protobuf, grpc-stub, protobuf-java-util) that must be added explicitly.
Without them, a NoClassDefFoundError is thrown at runtime when a request hits the route.
Added a "Required Dependencies" section with Maven and Gradle examples.

Closes spring-cloudgh-3424

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document required dependencies for JsonToGrpc Filter

2 participants