Skip to content

docs: document required dependencies for JsonToGrpc filter #4202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
won-seoop wants to merge 1 commit into
base: main
Choose a base branch
from
+47 −0
Open

docs: document required dependencies for JsonToGrpc filter #4202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions ...ng-cloud-gateway-server-webflux/gatewayfilter-factories/jsontogrpc-factory.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,53 @@

The JSONToGRPC GatewayFilter Factory converts a JSON payload to a gRPC request.

[[jsontogrpc-dependencies]]
== Required Dependencies

The `JsonToGrpc` filter depends on several optional libraries that are *not* included by default.
You must add them explicitly to your project:

.Maven
[source,xml]
----
<dependency>
<groupId>tools.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-protobuf</artifactId>
</dependency>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-netty</artifactId>
</dependency>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-protobuf</artifactId>
</dependency>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-stub</artifactId>
</dependency>
<dependency>
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java-util</artifactId>
</dependency>
----

.Gradle
[source,groovy]
----
implementation 'tools.jackson.dataformat:jackson-dataformat-protobuf'
implementation 'io.grpc:grpc-netty'
implementation 'io.grpc:grpc-protobuf'
implementation 'io.grpc:grpc-stub'
implementation 'com.google.protobuf:protobuf-java-util'
----

[WARNING]
====
If any of these dependencies are missing you will see a `NoClassDefFoundError` at runtime (for example, `com/fasterxml/jackson/dataformat/protobuf/ProtobufFactory`) when a request hits the route.
The versions are managed by the Spring Cloud Gateway BOM, so no version attributes are needed when using the BOM.
====

The filter takes the following arguments:

* `service`: Short name of the service that handles the request.
Expand Down