mice

README

mice

Opinionated microservice framework designed for deployment on Kubernetes.

Minimal example:

package main

import (
	"github.com/MouseHatGames/mice"
	"github.com/MouseHatGames/mice-plugins/codec/json"
	"github.com/MouseHatGames/mice-plugins/transport/grpc"
)

func main() {
	svc := mice.NewService(
		options.Name("my-service"),
		options.RPCPort(8080),
		json.Codec(),
		grpc.Transport(),
	)

	if err := svc.Start(); err != nil {
		log.Fatalf("failed to start: %v", err)
	}
}

Documentation

Index

• type Service
  • func NewService(opts ...options.Option) Service

Types

type Service

type Service interface {
	// Apply applies one or more options to the service's configuration
	Apply(opts ...options.Option)

	Env() options.Environment
	Config() config.Config
	Name() string

	Server() server.Server
	Client() client.Client

	Start() error
}

Service represents a service that can receive and send requests

func NewService

func NewService(opts ...options.Option) Service

NewService instantiates a new service and initializes it with options