boards

Documentation

Index

• type Component
  • func NewComponent(config Config) (*Component, error)
  • func (c *Component) RegisterHttpHandlers(router *mux.Router, httpOpts []http.ServerOption)
• type Config
• type FirestoreConfig

Types

type Component

type Component struct {
	ApplicationService application.BoardApplicationService
	DataStore          domain.BoardDataStore
	Endpoints          transport.EndpointSet
}

Contains all the necessary elements for running the boards service, i.e. the boards part of the API.

func NewComponent

func NewComponent(config Config) (*Component, error)

func (*Component) RegisterHttpHandlers

func (c *Component) RegisterHttpHandlers(router *mux.Router, httpOpts []http.ServerOption)

type Config

type Config struct {
	Logger *log.Logger

	// If true, use an in-memory data store.
	UseInmemDataStore bool
	// Used to create a firestore data store if UseInmemDataStore is set to false.
	FirestoreConfig *FirestoreConfig
	// AuthorizationStore used to perform authorization in the application service.
	AuthorizationStore auth.AuthorizationStore

	// Middlewares that should be applied to all endpoints
	Middlewares []endpoint.Middleware
	// Authentication middleware for endpoints.
	AuthMiddleware endpoint.Middleware
	// Whether to add the logging middleware from the "internal/pkg/endpoint" package to every endpoint.
	// It logs errors from the underlying application service, not any errors produced by endpoint middlewares.
	UseLoggingMiddleware bool
}

Configures a boards component.

type FirestoreConfig

type FirestoreConfig struct {
	Client *firestore.Client
}