grpcapp

README

grpcapp

A simple wrapper for gRPC microservices.

Features

• Built-in CLI generator.
• Tiny and elegant.
• Includes exactly what's required.

License

The grpcapp package is open-sourced software licensed under the MIT license.

Documentation

Index

• func Start(options ...Option)
• type App
  • func New(options ...Option) App
• type Config
• type Implementation
• type Option
  • func WithConfig(cfg *Config) Option
  • func WithDatabase(db *pgx.Conn) Option
  • func WithGrpcServer(srv *grpc.Server) Option
  • func WithGrpcServerOptions(options ...grpc.ServerOption) Option
  • func WithHTTP() Option
  • func WithHttpServer(srv *http.Server) Option
  • func WithLogger(log *zap.Logger) Option
  • func WithServiceImplementation(desc *grpc.ServiceDesc, impl Implementation) Option
• type Tools

Functions

func Start

func Start(options ...Option)

Start shortcut to New().Listen().

Types

type App

type App interface {
	Start()
}

App interface.

func New

func New(options ...Option) App

New app generator.

type Config

type Config struct {
	DatabaseDSN    string `env:"DATABASE_DSN"`
	LogLevel       string `env:"LOG_LEVEL" envDefault:"info"`
	GrpcListenPort int    `env:"GRPC_LISTEN_PORT" envDefault:"9000"`
	HttpListenPort int    `env:"HTTP_LISTEN_PORT" envDefault:"8080"`
	TLSCertificate string `env:"TLS_CERTIFICATE"`
	TLSKey         string `env:"TLS_KEY"`
}

Config of the application.

type Implementation

type Implementation interface {
	UseTools(Tools)
}

Implementation interface.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option interface.

func WithConfig

func WithConfig(cfg *Config) Option

func WithDatabase

func WithDatabase(db *pgx.Conn) Option

func WithGrpcServer

func WithGrpcServer(srv *grpc.Server) Option

func WithGrpcServerOptions

func WithGrpcServerOptions(options ...grpc.ServerOption) Option

func WithHTTP

func WithHTTP() Option

func WithHttpServer

func WithHttpServer(srv *http.Server) Option

func WithLogger

func WithLogger(log *zap.Logger) Option

func WithServiceImplementation

func WithServiceImplementation(desc *grpc.ServiceDesc, impl Implementation) Option

type Tools

type Tools interface {
	Config() *Config
	DB() *pgx.Conn
	Log() *zap.Logger
}

Tools interface.