microgen

Microgen

Tool to generate microservices, based on go-kit, by specified service interface.

Install

go get -u github.com/devimteam/microgen/cmd/microgen

Usage

microgen [OPTIONS]

microgen is stable, so you can generate without flag -init any time your interface changed (e.g. added new method)

Options

* Required option

Example

Follow this short guide to try microgen tool.

1. Create file service.go inside GOPATH and add code below.

package stringsvc

import (
	"context"

	drive "google.golang.org/api/drive/v3"
)

type StringService interface {
	Uppercase(ctx context.Context, str string) (ans string, err error)
	Count(ctx context.Context, text string, symbol string) (count int, positions []int)
	TestCase(ctx context.Context, comments []*drive.Comment) (err error)
}

1. Open command line next to your service.go.
2. Enter microgen -file ./service.go -interface StringService -out . -grpc -init. *
3. You should see something like that:

exchanges.go
endpoints.go
client.go
middleware/middleware.go
middleware/logging.go
transport/grpc/server.go
transport/grpc/client.go
transport/converter/protobuf/endpoint_converters.go
transport/converter/protobuf/type_converters.go
All files successfully generated

1. Now, add and generate protobuf file, write converters from protobuf to golang and vise versa.
2. Use endpoints and converters in your package main or wherever you want.

* GOPATH/bin should be in your PATH.

Interface declaration rules

For correct generation, please, follow rules below.

• All interface method's arguments and results should be named and should be different (name duplicating unacceptable).
• First argument of each method should be of type context.Context (from standard library).
• Method results should contain at least one variable of error type.
• Some names are not allowed to be an argument or result.
• Field names in protobuf messages should be the same, as in interface methods (protobuf - snake_case, interface - camelCase).

Not allowed names:

req
request
resp
response

Misc

Microgen uses 0.9.* version of devimteam/go-kit