Categorygithub.com/gunk/gunk-example-server
modulepackage
0.0.0-20220923225617-3b9ec853f63a
Repository: https://github.com/gunk/gunk-example-server.git
Documentation: pkg.go.dev

# README

About gunk-example-server

Demonstrates building example gRPC servers with OpenAPI (Swagger) annotations in Go using Gunk definitions.

FileDescription
.gunkconfigGunk project configuration
main.gogRPC server implementation
cmd/gunk-example-server-gw/main.goREST gateway and Swagger docs
api/v1/util.gunkGunk echo service example
api/v1/countries.gunkGunk countries service example

Using

# clone
$ git clone https://github.com/gunk/gunk-example-server.git && cd gunk-example-server

# install protobuf tools / generator dependencies
$ ./install.sh

# build and run gRPC server
$ go build && ./gunk-example-server

# build and run REST gateway and Swagger doc site
$ go build ./cmd/gunk-example-server-gw && ./gunk-example-server-gw

# test
$ ./test.sh

The OpenAPI (ie, Swagger) definitions can be viewed with ReDoc by visiting localhost:9091/redoc.

# Packages

No description provided by the author
No description provided by the author

# Functions

NewServer creates a new server.

# Structs

Server is a util server.