Skip to content

docs: Add required dependencies for JsonToGrpc filter #4117

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
Tarte12 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add required dependencies for JsonToGrpc filter #4117

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
28 changes: 28 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,34 @@

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

[[jsontogrpc-dependencies]]
== Required Dependencies

The `JsonToGrpc` filter relies on optional dependencies that are not included transitively.
You must add the following to your project:

[source,xml]
----
<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>
----

NOTE: Without these dependencies, the gateway will throw a `NoClassDefFoundError` at runtime when the filter is invoked.

The filter takes the following arguments:

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