api

Documentation

Index

• func OkHandler(ctx context.Context) http.Handler
• type API
  • func New(cfg Config) API
• type APIMock
  • func (mock *APIMock) RegisterRoutes(ctx context.Context, routes ...Route) error
  • func (mock *APIMock) RegisterRoutesCalls() []struct{ ... }
  • func (mock *APIMock) Run(ctx context.Context) error
  • func (mock *APIMock) RunCalls() []struct{ ... }
  • func (mock *APIMock) Shutdown(ctx context.Context) error
  • func (mock *APIMock) ShutdownCalls() []struct{ ... }
• type Config
  • func (a *Config) Validate() error
• type ErrCreateOpenapiSchema
  • func (e ErrCreateOpenapiSchema) Error() string
• type Route
• type TLSConfig

Functions

func OkHandler

func OkHandler(ctx context.Context) http.Handler

OkHandler returns a handler that will serve status ok

Types

type API

type API interface {
	Run(ctx context.Context) error
	Shutdown(ctx context.Context) error
	RegisterRoutes(ctx context.Context, routes ...Route) error
}

func New

func New(cfg Config) API

New creates a new api

type APIMock

type APIMock struct {
	// RegisterRoutesFunc mocks the RegisterRoutes method.
	RegisterRoutesFunc func(ctx context.Context, routes ...Route) error

	// RunFunc mocks the Run method.
	RunFunc func(ctx context.Context) error

	// ShutdownFunc mocks the Shutdown method.
	ShutdownFunc func(ctx context.Context) error
	// contains filtered or unexported fields
}

APIMock is a mock implementation of API.

func TestSomethingThatUsesAPI(t *testing.T) {

	// make and configure a mocked API
	mockedAPI := &APIMock{
		RegisterRoutesFunc: func(ctx context.Context, routes ...Route) error {
			panic("mock out the RegisterRoutes method")
		},
		RunFunc: func(ctx context.Context) error {
			panic("mock out the Run method")
		},
		ShutdownFunc: func(ctx context.Context) error {
			panic("mock out the Shutdown method")
		},
	}

	// use mockedAPI in code that requires API
	// and then make assertions.

}

func (*APIMock) RegisterRoutes

func (mock *APIMock) RegisterRoutes(ctx context.Context, routes ...Route) error

RegisterRoutes calls RegisterRoutesFunc.

func (*APIMock) RegisterRoutesCalls

func (mock *APIMock) RegisterRoutesCalls() []struct {
	Ctx    context.Context
	Routes []Route
}

RegisterRoutesCalls gets all the calls that were made to RegisterRoutes. Check the length with:

len(mockedAPI.RegisterRoutesCalls())

func (*APIMock) Run

func (mock *APIMock) Run(ctx context.Context) error

Run calls RunFunc.

func (*APIMock) RunCalls

func (mock *APIMock) RunCalls() []struct {
	Ctx context.Context
}

RunCalls gets all the calls that were made to Run. Check the length with:

len(mockedAPI.RunCalls())

func (*APIMock) Shutdown

func (mock *APIMock) Shutdown(ctx context.Context) error

Shutdown calls ShutdownFunc.

func (*APIMock) ShutdownCalls

func (mock *APIMock) ShutdownCalls() []struct {
	Ctx context.Context
}

ShutdownCalls gets all the calls that were made to Shutdown. Check the length with:

len(mockedAPI.ShutdownCalls())

type Config

type Config struct {
	ListeningAddress string    `yaml:"address" mapstructure:"address"`
	Tls              TLSConfig `yaml:"tls" mapstructure:"tls"`
}

Config is the configuration for the data API

func (*Config) Validate

func (a *Config) Validate() error

type ErrCreateOpenapiSchema

type ErrCreateOpenapiSchema struct {
	// contains filtered or unexported fields
}

func (ErrCreateOpenapiSchema) Error

func (e ErrCreateOpenapiSchema) Error() string

type Route

type Route struct {
	Path    string
	Method  string
	Handler http.HandlerFunc
}

type TLSConfig

type TLSConfig struct {
	Enabled  bool   `yaml:"enabled" mapstructure:"enabled"`
	CertPath string `yaml:"certPath" mapstructure:"certPath"`
	KeyPath  string `yaml:"keyPath" mapstructure:"keyPath"`
}