api

Documentation

Index

• Variables
• type Api
  • func NewApi(controllers *controllers.Controllers, echoFilter *rbac.EchoAccessFilter, ...) (api *Api)
  • func (a *Api) CustomMatcher(key string) (string, bool)
  • func (a *Api) Echo() *echo.Echo
  • func (a *Api) Shutdown(ctx context.Context) (err error)
  • func (a *Api) Start() (err error)
• type Config
  • func (c Config) String() string

Variables

var SwaggerAssets embed.FS

var TypedocAssets embed.FS

Types

type Api

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

Api ...

func NewApi

func NewApi(controllers *controllers.Controllers,
	echoFilter *rbac.EchoAccessFilter,
	cfg Config,
	eventBus bus.Bus) (api *Api)

NewApi ...

func (*Api) CustomMatcher

func (a *Api) CustomMatcher(key string) (string, bool)

CustomMatcher ...

func (*Api) Echo

func (a *Api) Echo() *echo.Echo

func (*Api) Shutdown

func (a *Api) Shutdown(ctx context.Context) (err error)

Shutdown ...

func (*Api) Start

func (a *Api) Start() (err error)

Start ...

type Config

type Config struct {
	HttpPort int
	Swagger  bool
	Debug    bool
	Pprof    bool
	Gzip     bool
}

Config ...

func (Config) String

func (c Config) String() string

String ...