intermediate

Documentation

Overview

Package intermediate serves as the foundation of the helloworld.example microservice.

The HelloWorld microservice demonstrates the minimalist classic example.

Index

• type Intermediate
  • func NewService(impl ToDo, version int) *Intermediate
• type Mock
  • func NewMock() *Mock
  • func (svc *Mock) HelloWorld(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Mock) MockHelloWorld(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock
  • func (svc *Mock) OnShutdown(ctx context.Context) (err error)
  • func (svc *Mock) OnStartup(ctx context.Context) (err error)
• type ToDo

Types

type Intermediate

type Intermediate struct {
	*connector.Connector
	// contains filtered or unexported fields
}

Intermediate extends and customizes the generic base connector. Code generated microservices then extend the intermediate.

func NewService

func NewService(impl ToDo, version int) *Intermediate

NewService creates a new intermediate service.

type Mock

type Mock struct {
	*Intermediate
	// contains filtered or unexported fields
}

Mock is a mockable version of the helloworld.example microservice, allowing functions, event sinks and web handlers to be mocked.

func NewMock

func NewMock() *Mock

NewMock creates a new mockable version of the microservice.

func (*Mock) HelloWorld

func (svc *Mock) HelloWorld(w http.ResponseWriter, r *http.Request) (err error)

HelloWorld runs the mock handler set by MockHelloWorld.

func (*Mock) MockHelloWorld

func (svc *Mock) MockHelloWorld(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock

MockHelloWorld sets up a mock handler for the HelloWorld endpoint.

func (*Mock) OnShutdown

func (svc *Mock) OnShutdown(ctx context.Context) (err error)

OnShutdown is a no op.

func (*Mock) OnStartup

func (svc *Mock) OnStartup(ctx context.Context) (err error)

OnStartup makes sure that the mock is not executed in a non-dev environment.

type ToDo

type ToDo interface {
	OnStartup(ctx context.Context) (err error)
	OnShutdown(ctx context.Context) (err error)
	HelloWorld(w http.ResponseWriter, r *http.Request) (err error)
}

ToDo defines the interface that the microservice must implement. The intermediate delegates handling to this interface.