http

Documentation

Index

• type Router
  • func NewRouter(rs RouterSettings) *Router
  • func (r *Router) Register(basePath string, middlewares []echo.MiddlewareFunc)
  • func (r *Router) Start() error
  • func (r *Router) Stop() error
• type RouterSettings
  • func (rs RouterSettings) SetDefaults() RouterSettings

Types

type Router

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

func NewRouter

func NewRouter(rs RouterSettings) *Router

func (*Router) Register

func (r *Router) Register(basePath string, middlewares []echo.MiddlewareFunc)

Register

@title Telemetry @version 1.0 @description telemetry example project

@contact.name DeepCore Team @contact.email @FINOPS @DEEPCORE

@host @BasePath /api/v1

func (*Router) Start

func (r *Router) Start() error

func (*Router) Stop

func (r *Router) Stop() error

type RouterSettings

type RouterSettings struct {
	// Host like 0.0.0.0:8080
	Host string
	// BasePath for serving
	BasePath string
	// ShutdownTimeout using in shutdown server default is 5 second.
	ShutdownTimeout time.Duration
}

func (RouterSettings) SetDefaults

func (rs RouterSettings) SetDefaults() RouterSettings