SkemaBuild

Your One-Stop command line tool to generate grpc-go code from protobuf file AUTOMATICALLY.
And it's dev ready and production ready!

• taking care of all necessary protocol buffers/grpc/plugins/dependencies installation
• publish grpc stubs automatically
• Support github and any other git repo host (e.g. gitlab, bitbucket, whatever)!!
• Customizable online code templates
• Generate production level grpc service code automatically! Not dummy sample code
• It's FAST! Generating ready-to-go code from protocol buffers has never been so fast!!

Quick Start

1. Installation

First, make sure you have golang installed.
Then setup necessary protocol buffers related tools:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/skema-dev/skemabuild/main/script/install.sh)"

---

2. (Optional) Get Github Device Auth (if you want to publish protobuf&stubs on github)

skbuild auth

You'll be prompted to open github device auth URL and input the token. Then just press Enter to save the github token on your local device.

---

3. Init and Publish Protobuf API

Now run and test(The following example is using my own sample repo. Change with your own account and repo)

# create an initial protocol buffers file
skbuild api init --package=com.pack1 --service=hello

# create stubs for grpc-go and openapi, using protobuf file Hello1.proto, and output to ./stub-test
skbuild api create --go_option github.com/likezhang-public/newst/test001/com.pack1/grpc-go --input ./hello.proto -o ./stub-test

# after stubs are created, upload to github and set the version tag
# the "url" argument is for verifying the go_package option defined above
skbuild api publish --stub=./stub-test --url  https://github.com/likezhang-public/newst/test001 --version=v0.0.1

# verify the package is downloadable
skbuild get github.com/likezhang-public/newst/test001/com.pack1/[email protected]

You can also skip creating local stubs and publish to github directly:

skbuild api init --package=com.pack1 --service=hello

# here we combine the two steps (create and publish) into a single process to simplify the workflow
skbuild api publish --proto=./hello.proto --url  https://github.com/likezhang-public/newst/test2 --version=v0.0.2

go get github.com/likezhang-public/newst/test2/com.pack1/[email protected]

How about publishing to non-github repository? How about gitlab/bitbucket or private git hosting?
Check out #6 for details. It's almost the same process :)

---

4. Generate gRPC Service Code

Now it's the final step: generate runnable gRPC service code automatically!
Just use the following example to specify the protobuf file you published online

skbuild service create --proto https://github.com/likezhang-public/newst/blob/main/test2/com.pack1/grpc-go/Hello.proto

Then we'll have the following code layout in current path. (you can specify output path by using --output) . ├── cmd
│ └── hello1service
│ ├── config
│ │ └── grpc.yaml
│ ├── main.go
│ └── service
│ └── service.go
├── go.mod
└── internal
└── README.md

---

5. Run the service code

To test it out, run go mod tidy first to install dependencies, then go to cmd/hello1service and go run .

go mod tidy
cd cmd/helloservice
go run .

You'll see the launching information of grpc service and the http endpoint gateway:

2022-06-07T00:48:32.460+0800	INFO	logging/logging.go:96	using local config from ./config/grpc.yaml
2022-06-07T00:48:32.460+0800	INFO	logging/logging.go:66	service port	{"gprc": 9991, "http": 9992}
2022-06-07T00:48:32.461+0800	INFO	logging/logging.go:96	gateway path is set to /
2022-06-07T00:48:32.461+0800	INFO	logging/logging.go:66	logging initialized:	{"level": "debug", "encoding": "console"}
2022-06-07T00:48:32.461+0800	INFO	logging/logging.go:96	Serving gRPC start...

To further understand how the code is designed, Please checkout our Skema-Go Framework

---

6. Support for other GIT Servers

SkemaBuild is also capable of publishing stubs to your private git server. Underlying the hood, it's using git-go package to simulate git client and pushing files to repo.
Comparing with publishing on github, you'll have to do three things differently:

• You need to have ~/.ssh/id_rsa file and authenticated in your git server (e.g. gitlab or others)
• Clone the git repo on your local path
• Specify the go_package option explicitly when creating stubs

That's it. The whole workflow is the same as previously. Let's use gitlab as an example:

# clone the git repo
git clone [email protected]:likexx/test1.git
cd test1

# init protobuf file
skbuild api init --package=org.test --service=Hello3

# generate stubs and output to ./temp, using user specified go_option
skbuild api create -i ./Hello3.proto -o ./temp --go_option "gitlab.com/likexx/test1/stub/org.test/grpc-go"

# publish stubs from ./temp to the repo (assuming the command is executed at the repository root).
# "stub" is the user specified path in the repo
skbuild api publish -s ./temp -u stub --version v1.0.2

# create grpc service from the raw protobuf file link
# you may need to run `skbuild auth -t github` in order to use the code template on github repo
skbuild service create -p https://gitlab.com/likexx/test1/-/raw/main/stub/org.test/grpc-go/Hello3.proto

go mod tidy
cd cmd
cd hello3service
go run .

7. Use Username and Password for Git Http Auth

Some users might clone repo using https instead of ssh. No problem! Just specify your username and password when publishing protobuf stubs:

skbuild api publish -s ./temp -u stub --version v1.0.1 --username=<your git username> --password=<your password>