nestjs-grpc-ui
v0.0.3
Published
NestJS GRPC UI is a library that provides a simple UI to interact with your GRPC server using the reflection API. You can see the available services and methods, and test them directly from here.
Downloads
8
Maintainers
Readme
Nest Grpc UI
A NestJS module provides a simple UI to interact with gRPC services in a NestJS application.
Installation
npm install nest-grpc-ui
Motivation
gRPC is a high-performance, open-source, universal RPC framework that enables efficient communication between microservices. Nest Grpc UI is motivated by the need for a user-friendly interface to interact with gRPC services in a NestJS application. By providing a simple and intuitive UI, developers can easily test, debug, and monitor their gRPC services, enhancing the overall development experience.
Usage
First you need to import the module in your app.module.ts
file:
import { Module } from "@nestjs/common";
import { GrpcUiModule } from "nestjs-grpc-ui";
@Module({
imports: [
GrpcUiModule.forRoot({
grpcServer: "localhost:50051",
endpointUI: "/grpc-ui",
enabled: true, // Optional, default is true (this is useful to disable the UI in production environments)
}),
],
})
export class AppModule {}
Then you can use the UI by accessing the /grpc-ui
endpoint in your browser 🚀
Stay in touch
- Author - Matias Capuano
- LinkedIn - Matias Capuano
License
nest-grpc-ui
is MIT licensed.