gRPCox

turn gRPCurl into web based UI, extremely easy to use

Features

• Recognize and provide list of services and methods inside it as an options.
• Automatically recognize schema input and compose it into JSON based. (ensure your gRPC server supports server reflection). Examples for how to set up server reflection can be found here.
• Save established connection, and reuse it for next invoke/request (also can close/restart connection)

Installation

Docker

docker pull gusaul/grpcox:latest

then run

docker run -p 6969:6969 -v {ABSOLUTE_PATH_TO_LOG}/log:/log -d gusaul/grpcox

Docker Compose

from terminal, move to grpcox directory, then run command

docker-compose up

if you're using docker and want to connect gRPC on your local machine, then use
host.docker.internal:<your gRPC port> instead of localhost

Golang

if you have golang installed on your local machine, just run command

make start

from grpcox directory

configure app preferences by editing config.env file

var	usage	type	unit
MAX_LIFE_CONN	maximum idle time connection before closed	number	minute
TICK_CLOSE_CONN	ticker interval to sweep expired connection	number	second
BIND_ADDR	ip:port to bind service	string

set value 0 (zero) to disable auto close idle connection.

Demo

Using AssetFs

By using assetfs this tool can be compiled into 1 binary file, so that it will be easier to use.

Please update assetfs when any files inside index folder are modified:

# Install required package
$ go get github.com/go-bindata/go-bindata/...
$ go get github.com/elazarl/go-bindata-assetfs/...

# Update assetfs
$ go-bindata-assetfs -pkg handler -o handler/binddata.go  index/... 

Compile

if you have golang installed on your local machine, just run command

# Windows
go build -o grpcox.exe

# Unix
go build -o grpcox

from grpcox directory

configure app preferences by editing config.env file

var	usage	type	unit
MAX_LIFE_CONN	maximum idle time connection before closed	number	minute
TICK_CLOSE_CONN	ticker interval to sweep expired connection	number	second
BIND_ADDR	ip:port to bind service	string

set value 0 (zero) to disable auto close idle connection.

How to use?

Copy your binary file (ex: grpcox.exe) to your favorite folder, and just run it.