Skip to content

Commit 30db076

Browse files
committed
Minor doc improvements
1 parent d3a32d5 commit 30db076

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

vertx-grpc-docs/src/main/asciidoc/server.adoc

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -346,21 +346,46 @@ handle the message encoding:
346346
- when the message uses the response encoding, the message is sent as is
347347
- when the message uses a different encoding, it will be encoded, e.g. compressed or uncompressed
348348

349-
=== gRPC Reflection APIs
349+
=== gRPC Reflection service
350350

351-
Support for the https://grpc.io/docs/guides/reflection/[gRPC reflection APIs] can be added to your Vert.x gRPC Server.
351+
Support for the https://grpc.io/docs/guides/reflection/[gRPC reflection service] can be added to your Vert.x gRPC Server.
352+
353+
To use the Reflection service, add the following dependency:
354+
355+
* Maven (in your `pom.xml`):
356+
357+
[source,xml,subs="+attributes"]
358+
----
359+
<dependency>
360+
<groupId>io.vertx</groupId>
361+
<artifactId>vertx-grpc-reflection</artifactId>
362+
<version>${maven.version}</version>
363+
</dependency>
364+
----
365+
366+
* Gradle (in your `build.gradle` file):
367+
368+
[source,groovy,subs="+attributes"]
369+
----
370+
dependencies {
371+
compile 'io.vertx:vertx-grpc-reflection:${maven.version}'
372+
}
373+
----
374+
375+
You can then deploy the reflection service in your server:
352376

353377
[source,java]
354378
----
355379
{@link examples.GrpcServerExamples#reflectionExample}
356380
----
357381

358-
=== gRPC Health Service
382+
=== gRPC Health service
383+
384+
The gRPC Health service implements the standard https://github.com/grpc/grpc/blob/master/doc/health-checking.md[gRPC health checking protocol], which allows clients to check the health status of your services.
359385

360-
The gRPC Health Service implements the standard https://github.com/grpc/grpc/blob/master/doc/health-checking.md[gRPC health checking protocol], which allows clients to check the health status of your services.
361386
By default `HealthService` returns all registered services with status `SERVING`, if you want to override this, you need to register health check, for the specified service.
362387

363-
The Health Service provides a simple way to expose health status of your services via gRPC.
388+
The Health service provides a simple way to expose health status of your services via gRPC.
364389
It implements two RPCs:
365390

366391
* `Check`: For checking the health status of a service
@@ -389,7 +414,7 @@ dependencies {
389414
}
390415
----
391416

392-
Here's how to create and bind a Health Service to your gRPC server:
417+
Here's how to create and bind a Health service to your gRPC server:
393418

394419
[source,java]
395420
----

0 commit comments

Comments
 (0)