Welcome to grpc-json-mock 😀
A GRPC mock server for front-end development.
Multiple APIs are supported.
Supports the following APIs
unary
serverStreming
clientStreming
duplexStreming
By specifying a proto file, you can output a json template for use in mock.
node ./node_module/.bin/gen-grpc-template {path}
Parameter
Description
path
Set the directory where the proto file or proto file is located
option
Description
-i
import another path
syntax = "proto3" ;
package helloworld ;
service Greeter {
rpc unary (UnaryRequest ) returns (UnaryResponse ) {}
rpc serverStreaming (UnaryRequest ) returns (stream UnaryResponse ) {}
rpc clientStreaming (stream UnaryRequest ) returns (UnaryResponse ) {}
rpc duplexStreaming (stream UnaryRequest ) returns (stream UnaryResponse ) {}
}
message UnaryRequest {
string name = 1 ;
}
message UnaryResponse {
string message = 1 ;
}
generate...
{
"protos" : [
{
"path" : " example/protos/helloWorld.proto" ,
"pkg" : " helloworld" ,
"options" : {},
"services" : [
{
"name" : " Greeter" ,
"methods" : [
{ "name" : " unary" , "output" : {} },
{ "name" : " serverStreaming" , "output" : {} },
{ "name" : " clientStreaming" , "output" : {} },
{ "name" : " duplexStreaming" , "output" : {} }
]
}
]
}
]
}
Parameter
Type
Description
name
string
Required. Set method name from ptoro file.
output
Object | Array<object>
Set response from server.
streamInterval
number
Set the sense of server streaming.Unit is msec. default 1000
error
Object
Set grpc error. https://cloud.google.com/apis/design/errors#error_model
https://github.com/activeguild/grpc-json-mock/tree/master/example