nice-grpc-server-reflection

import { Server as GrpcServer, ServiceDefinition, UntypedServiceImplementation } from 'nice-grpc'; import { ServerReflectionService, ServerReflection } from 'nice-grpc-server-reflection'; import * as fs from 'fs'; import * as path from 'path'; // 1. Define your .proto file (e.g., proto/greeting.proto): // syntax = "proto3"; // package greeting; // service Greeter { rpc SayHello (HelloRequest) returns (HelloReply) {} } // message HelloRequest { string name = 1; } // message HelloReply { string message = 1; } // 2. Generate the descriptor set using protoc: // `protoc --descriptor_set_out=./proto/bundle.bin --include_imports -I./proto ./proto/greeting.proto` // 3. Define your gRPC service implementation const greeterService: ServiceDefinition & UntypedServiceImplementation = { path: '/greeting.Greeter/SayHello', requestStream: false, responseStream: false, requestType: {} as any, // In a real app, these would be generated types responseType: {} as any, // In a real app, these would be generated types async handler(request: { name: string }) { return { message: `Hello, ${request.name}!` }; } }; const main = async () => { const server = new GrpcServer(); // Load the generated protobuf descriptor set const protoset = fs.readFileSync(path.join(__dirname, '../proto/bundle.bin')); // Add your application service server.add('greeting.Greeter', greeterService); // Add the server reflection service // Pass the protoset and a list of fully-qualified service names to expose server.add( ServerReflectionService, ServerReflection( protoset, ['greeting.Greeter'] ) ); const port = 50051; await server.listen(`0.0.0.0:${port}`); console.log(`nice-grpc server with reflection listening on port ${port}`); // You can now use grpcurl to inspect and call services: // `grpcurl -plaintext localhost:50051 list` // `grpcurl -plaintext localhost:50051 describe greeting.Greeter` // `grpcurl -plaintext -d '{"name": "World"}' localhost:50051 greeting.Greeter/SayHello` }; main().catch(console.error);