Service Inspection with grpcurl

This guide explains how to inspect and test your gRPC services with grpcurl in a Sword application.

For .proto contract design recommendations, see .proto Files.

Minimum requirements

1. Have grpcurl installed.
2. Have at least one registered gRPC controller.
3. Enable reflection in the configuration:

[grpc]
enable-tonic-reflection = true

Reflection is registered from build.rs

For reflection to expose your services and types, your build.rs must generate sword_descriptor_set.bin in OUT_DIR. See Compiling Protos.

Basic grpcurl commands

Assuming a server at 127.0.0.1:50051:

List services

grpcurl -plaintext 127.0.0.1:50051 list

Describe a service

grpcurl -plaintext 127.0.0.1:50051 describe users.UserService

Global health check

grpcurl -plaintext -d '{"service":""}' 127.0.0.1:50051 grpc.health.v1.Health/Check

Run a method with metadata

grpcurl -plaintext -H 'authorization: bearer test' -d '{}' 127.0.0.1:50051 users.UserService/ListUsers