endpoint

Documentation

Index

• func IsInvalidConfig(err error) bool
• type Config
  • func DefaultConfig() Config
• type Endpoint
  • func New(config Config) (*Endpoint, error)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	// Dependencies.
	Logger     micrologger.Logger
	Middleware *middleware.Middleware
	Service    *service.Service
}

Config represents the configuration used to create a endpoint.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new endpoint by best effort.

type Endpoint

type Endpoint struct {
	Version *version.Endpoint
}

Endpoint is the endpoint collection.

func New

func New(config Config) (*Endpoint, error)

New creates a new configured endpoint.