api

Documentation

Index

• type DashboardHandler
  • func (g DashboardHandler) Append(router *mux.Router)
• type DebugHandler
  • func (g DebugHandler) Append(router *mux.Router)
• type Handler
  • func (h Handler) Append(router *mux.Router)
• type MiddlewareRepresentation
• type ProviderRepresentation
• type ResourceIdentifier
• type RouterRepresentation
• type ServiceRepresentation

Types

type DashboardHandler

type DashboardHandler struct {
	Assets *assetfs.AssetFS
}

DashboardHandler expose dashboard routes

func (DashboardHandler) Append

func (g DashboardHandler) Append(router *mux.Router)

Append add dashboard routes on a router

type DebugHandler

type DebugHandler struct{}

DebugHandler expose debug routes

func (DebugHandler) Append

func (g DebugHandler) Append(router *mux.Router)

Append add debug routes on a router

type Handler

type Handler struct {
	EntryPoint            string
	Dashboard             bool
	Debug                 bool
	CurrentConfigurations *safe.Safe
	Statistics            *types.Statistics
	Stats                 *thoasstats.Stats
	// StatsRecorder         *middlewares.StatsRecorder // FIXME stats
	DashboardAssets *assetfs.AssetFS
}

Handler expose api routes

func (Handler) Append

func (h Handler) Append(router *mux.Router)

Append add api routes on a router

type MiddlewareRepresentation

type MiddlewareRepresentation struct {
	*config.Middleware
	ID string `json:"id"`
}

MiddlewareRepresentation extended version of a middleware configuration with an ID

type ProviderRepresentation

type ProviderRepresentation struct {
	Routers     []ResourceIdentifier `json:"routers,omitempty"`
	Middlewares []ResourceIdentifier `json:"middlewares,omitempty"`
	Services    []ResourceIdentifier `json:"services,omitempty"`
}

ProviderRepresentation a provider with resource identifiers

type ResourceIdentifier

type ResourceIdentifier struct {
	ID   string `json:"id"`
	Path string `json:"path"`
}

ResourceIdentifier a resource identifier

type RouterRepresentation

type RouterRepresentation struct {
	*config.Router
	ID string `json:"id"`
}

RouterRepresentation extended version of a router configuration with an ID

type ServiceRepresentation

type ServiceRepresentation struct {
	*config.Service
	ID string `json:"id"`
}

ServiceRepresentation extended version of a service configuration with an ID