grpc-gateway-boilerplate

README

Grpc gateway example

This has multiple proto files combined into a single project

This is forked from johanbrandhorst/grpc-gateway-boilerplate and combined with code from https://github.com/raahii/golang-grpc-realworld-example and is being used for testing purposes

All the boilerplate you need to get started with writing grpc-gateway powered REST services in Go.

Once the server is started by running go run main.go The apis are listed as mentioned in the .proto files

/api/v1/users -- This talks to Mysql DB

/api/v1/articles -- This talks to Mysql DB

/api/v1/profiles -- This talks to Mysql DB

/api/v/exampleusers -- This talks to In Memory DB

P.S I am still in the learning phase and dont have enough knowledge to clean the codebase to use a single consistent logging

Also even though all the swaggers/open api docs are generated in the third_party folder, i couldnt find a way to combine all these into a single documentation

I havent setup a dependency management ,so in case new modules are added , you still have to run go get commands. So that is a pending item to be done here

Thanks to both Authors in taking so much pain to bring a realistic project in place.

Requirements

Go 1.16+

Running

Run make generate to generate the files

Running main.go starts a web server on https://0.0.0.0:11000/.

You can configure the port used with the $PORT environment variable, and to serve on HTTP set $SERVE_HTTP=true.

Run the below command if you modify the code make generate

$ go run main.go

An OpenAPI UI is served on https://0.0.0.0:11000/.

Running the standalone server

If you want to use a separate gRPC server, for example one written in Java or C++, you can run the standalone web server instead:

$ go run ./cmd/standalone/ --server-address dns:///0.0.0.0:10000

Getting started

After cloning the repo, there are a couple of initial steps;

1. If you forked this repo, or cloned it into a different directory from the github structure, you will need to correct the import paths. Here's a nice find one-liner for accomplishing this (replace yourscmprovider.com/youruser/yourrepo with your cloned repo path):

   $ find . -path ./vendor -prune -o -type f \( -name '*.go' -o -name '*.proto' \) -exec sed -i -e "s;github.com/ajishcherian1982/grpc-gateway-boilerplate;yourscmprovider.com/youruser/yourrepo;g" {} +
   

2. Finally, generate the files with make generate.

Now you can run the web server with go run main.go.

Making it your own

The next step is to define the interface you want to expose in proto/example.proto. See https://developers.google.com/protocol-buffers/ tutorials and guides on writing protofiles.

Once that is done, regenerate the files using make generate. This will mean you'll need to implement any functions in server/server.go, or else the build will fail since your struct won't be implementing the interface defined by the generated file in proto/example.pb.go.

This should hopefully be all you need to get started playing around with the gRPC-Gateway!