router

Documentation

Index

• type Route
• type Router
  • func NewRouter(options RouterOptions) *Router
  • func (router *Router) SetRoutes(routes []*Route)
  • func (router *Router) Start(port int)
• type RouterOptions

Types

type Route

type Route struct {
	Method  string
	Path    string
	Handler gin.HandlerFunc
	Action  string
}

Route represents an application route

type Router

type Router struct {
	*gin.Engine
	Logger          *cm_logger.Logger
	Authorizer      *cm_auth.Authorizer
	Routes          []*Route
	TlsCert         string
	TlsKey          string
	TlsCACert       string
	ContextPath     string
	Depth           int
	DepthDynamic    bool
	CORSAllowOrigin string
	ReadTimeout     time.Duration
	WriteTimeout    time.Duration
	Host            string
	WebTemplatePath string
}

Router handles all incoming HTTP requests

func NewRouter

func NewRouter(options RouterOptions) *Router

NewRouter creates a new Router instance

func (*Router) SetRoutes

func (router *Router) SetRoutes(routes []*Route)

SetRoutes applies list of routes

func (*Router) Start

func (router *Router) Start(port int)

type RouterOptions

type RouterOptions struct {
	Logger                *cm_logger.Logger
	LogLatencyInteger     bool
	Username              string
	Password              string
	ContextPath           string
	TlsCert               string
	TlsKey                string
	TlsCACert             string
	PathPrefix            string
	LogHealth             bool
	EnableMetrics         bool
	AnonymousGet          bool
	Depth                 int
	MaxUploadSize         int
	BearerAuth            bool
	AuthRealm             string
	AuthService           string
	AuthCertPath          string
	AuthActionsSearchPath string
	DepthDynamic          bool
	ReadTimeout           int
	WriteTimeout          int
	CORSAllowOrigin       string
	Host                  string
}

RouterOptions are options for constructing a Router