api

Documentation

Index

• func Docs(s chi.Router, pattern string, ...)
• type API
  • func New(apiPort int, swaggerPort int, ...) *API
  • func (a *API) Listen() error
  • func (a *API) MountRoutes() error
  • func (a *API) Routes() string

Functions

func Docs

func Docs(s chi.Router, pattern string, swgui func(title, schemaURL, basePath string) http.Handler, collector *openapi.Collector, spec *openapi3.Spec)

Types

type API

type API struct {
	Server *web.Service
	Nodes  []*node.Node
	//Global middleware
	Middleware []func(next http.Handler) http.Handler
	Wraps      []func(next http.Handler) http.Handler
	Actions    map[string]map[string]node.Handler
	// Port Defines the listening TCP Port for this when started
	Ports struct {
		API     int
		Swagger int
	}
}

func New

func New(apiPort int, swaggerPort int, options ...func(s *web.Service, initialized bool)) *API

func (*API) Listen

func (a *API) Listen() error

func (*API) MountRoutes

func (a *API) MountRoutes() error

func (*API) Routes

func (a *API) Routes() string