Skip to content

Docs: Document required dependency for JsonToGrpc filter#4152

Open
Ava051213 wants to merge 1 commit intospring-cloud:mainfrom
Ava051213:docs/3424-json-to-grpc-dependencies
Open

Docs: Document required dependency for JsonToGrpc filter#4152
Ava051213 wants to merge 1 commit intospring-cloud:mainfrom
Ava051213:docs/3424-json-to-grpc-dependencies

Conversation

@Ava051213
Copy link
Copy Markdown

What does this PR do?

Documents the required jackson-dataformat-protobuf dependency for the
JsonToGrpc filter.

Why is it needed?

Without this dependency, users get a NoClassDefFoundError when using the
JsonToGrpc filter.

Fixes #3424

Copilot AI review requested due to automatic review settings April 23, 2026 05:25
@Ava051213 Ava051213 force-pushed the docs/3424-json-to-grpc-dependencies branch from de0f5e8 to 47aa582 Compare April 23, 2026 05:28
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 JsonToGrpc filter documentation.
  • Document the com.fasterxml.jackson.dataformat:jackson-dataformat-protobuf dependency needed for JSON↔gRPC conversion.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +25 to +27
=== Required Dependencies

To use the `JsonToGrpc` filter, add the following dependencies:
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence refers to “dependencies” but only a single dependency is listed below. Update the wording to “dependency” to match the example.

Suggested change
=== Required Dependencies
To use the `JsonToGrpc` filter, add the following dependencies:
=== Required Dependency
To use the `JsonToGrpc` filter, add the following dependency:

Copilot uses AI. Check for mistakes.
@@ -22,6 +22,18 @@ src/main/resources/proto/hello.proto

NOTE: `streaming` is not supported.

=== Required Dependencies
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Suggested change
=== Required Dependencies
== Required Dependencies

Copilot uses AI. Check for mistakes.
@Ava051213 Ava051213 force-pushed the docs/3424-json-to-grpc-dependencies branch from 47aa582 to 2a37011 Compare April 23, 2026 05:35
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

3 participants