Inspección de servicios gRPC con grpcurl

Esta guía explica cómo inspeccionar y probar tus servicios gRPC con grpcurl en una aplicación Sword.

Para recomendaciones de diseño del contrato .proto, revisa Ficheros .proto.

Requisitos mínimos

1. Tener grpcurl instalado.
2. Tener al menos un controlador gRPC registrado.
3. Activar reflection en configuración:

[grpc]
enable-tonic-reflection = true

Generar descriptor en build.rs

Para que reflection exponga tus servicios y tipos, genera sword_descriptor_set.bin en OUT_DIR.

use std::{env, path::PathBuf};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let out_dir = PathBuf::from(env::var("OUT_DIR")?);
    let descriptor_set_path = out_dir.join("sword_descriptor_set.bin");

    tonic_prost_build::configure()
        .file_descriptor_set_path(&descriptor_set_path)
        .compile_protos(&["config/proto/users.proto"], &["config/proto"])?;

    Ok(())
}

Sword registra este descriptor automáticamente. No necesitas registrar reflection manualmente en tus módulos.

Comandos básicos con grpcurl

Asumiendo servidor en 127.0.0.1:50051:

Listar servicios:

grpcurl -plaintext 127.0.0.1:50051 list

Describir un servicio:

grpcurl -plaintext 127.0.0.1:50051 describe users.UserService

Health check global:

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

Ejecutar un método con metadata:

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