apis

Documentation

Index

• func DefaultRegistrar(_ Context, router *gin.Engine) error
• type Config
  • func ParseConfig(bz []byte) (*Config, error)
• type Configurator
• type Context
  • func NewContext(ctx registrar.Context, grpcConnection *grpc.ClientConn) Context
• type Module
  • func NewModule(ctx Context) *Module
  • func (m *Module) Logger() gin.HandlerFunc
  • func (m *Module) Name() string
  • func (m *Module) RunAdditionalOperations() error
  • func (m *Module) WithConfigurator(configurator Configurator) *Module
  • func (m *Module) WithRegistrar(registrar Registrar) *Module
• type Registrar
  • func CombinedRegistrar(registrars ...Registrar) Registrar

Functions

func DefaultRegistrar

func DefaultRegistrar(_ Context, router *gin.Engine) error

DefaultRegistrar returns the default API registrar

Types

type Config

type Config struct {
	Address string `yaml:"address,omitempty"`
	Port    uint   `yaml:"port"`
}

func ParseConfig

func ParseConfig(bz []byte) (*Config, error)

type Configurator

type Configurator func(router *gin.Engine, server *http.Server)

Configurator represents a function allowing to configure the Gin engine and the HTTP server. NOTE: Use this method only to configure either the router or the server, and NOT to register routes. Those will be registered using the various registrars set inside the module.

type Context

type Context struct {
	registrar.Context
	GRPCConnection *grpc.ClientConn
}

Context contains all the useful data that might be used when registering an API handler

func NewContext

func NewContext(ctx registrar.Context, grpcConnection *grpc.ClientConn) Context

type Module

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

Module represents the module allowing to register custom API endpoints

func NewModule

func NewModule(ctx Context) *Module

func (*Module) Logger

func (m *Module) Logger() gin.HandlerFunc

Logger returns a Gin Handler function that logs endpoint calls using ZeroLog

func (*Module) Name

func (m *Module) Name() string

func (*Module) RunAdditionalOperations

func (m *Module) RunAdditionalOperations() error

RunAdditionalOperations implements modules.AdditionalOperationsModule

func (*Module) WithConfigurator

func (m *Module) WithConfigurator(configurator Configurator) *Module

WithConfigurator allows setting the configurator to be used

func (*Module) WithRegistrar

func (m *Module) WithRegistrar(registrar Registrar) *Module

WithRegistrar allows setting the APIs registrar to be used

type Registrar

type Registrar func(ctx Context, router *gin.Engine) error

Registrar represents a function that allows registering API endpoints

func CombinedRegistrar

func CombinedRegistrar(registrars ...Registrar) Registrar

CombinedRegistrar returns a new Registrar combining the given API registrars together