routes

Documentation

Index

• Variables
• type PprofRoutes
  • func NewPprofRoutes(logger lib.Logger, handler lib.HttpHandler) PprofRoutes
  • func (a PprofRoutes) Setup()
• type PublicRoutes
  • func NewPublicRoutes(logger lib.Logger, handler lib.HttpHandler, ...) PublicRoutes
  • func (a PublicRoutes) Setup()
• type RoleRoutes
  • func NewRoleRoutes(logger lib.Logger, handler lib.HttpHandler, ...) RoleRoutes
  • func (a RoleRoutes) Setup()
• type Route
• type Routes
  • func NewRoutes(pprofRoutes PprofRoutes, swaggerRoutes SwaggerRoutes, ...) Routes
  • func (a Routes) Setup()
• type SwaggerRoutes
  • func NewSwaggerRoutes(config lib.Config, logger lib.Logger, handler lib.HttpHandler) SwaggerRoutes
  • func (a SwaggerRoutes) Setup()

Variables

var Module = fx.Options(
	fx.Provide(NewPprofRoutes),
	fx.Provide(NewSwaggerRoutes),
	fx.Provide(NewPublicRoutes),
	fx.Provide(NewUserRoutes),
	fx.Provide(NewRoleRoutes),
	fx.Provide(NewRoutes),
)

Module exports dependency to container

Types

type PprofRoutes

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

func NewPprofRoutes

func NewPprofRoutes(
	logger lib.Logger,
	handler lib.HttpHandler,
) PprofRoutes

NewUserRoutes creates new pprof routes

func (PprofRoutes) Setup

func (a PprofRoutes) Setup()

Setup pprof routes

type PublicRoutes

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

func NewPublicRoutes

func NewPublicRoutes(
	logger lib.Logger,
	handler lib.HttpHandler,
	publicController controllers.PublicController,
	captchaController controllers.CaptchaController,
) PublicRoutes

NewUserRoutes creates new public routes

func (PublicRoutes) Setup

func (a PublicRoutes) Setup()

Setup public routes

type RoleRoutes

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

func NewRoleRoutes

func NewRoleRoutes(
	logger lib.Logger,
	handler lib.HttpHandler,
	roleController controllers.RoleController,
) RoleRoutes

NewRoleRoutes creates new role routes

func (RoleRoutes) Setup

func (a RoleRoutes) Setup()

Setup role routes

type Route

type Route interface {
	Setup()
}

Route interface

type Routes

type Routes []Route

Routes contains multiple routes

func NewRoutes

func NewRoutes(
	pprofRoutes PprofRoutes,
	swaggerRoutes SwaggerRoutes,
	publicRoutes PublicRoutes,
	userRoutes UserRoutes,
	roleRoutes RoleRoutes,
	menuRoutes MenuRoutes,
) Routes

NewRoutes sets up routes

func (Routes) Setup

func (a Routes) Setup()

Setup all the route

type SwaggerRoutes

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

@securityDefinitions.apikey Authorization @in header @name Authorization @schemes http https @basePath / @contact.name LiuSha @contact.email liusha@email.cn

func NewSwaggerRoutes

func NewSwaggerRoutes(
	config lib.Config,
	logger lib.Logger,
	handler lib.HttpHandler,
) SwaggerRoutes

NewUserRoutes creates new swagger routes

func (SwaggerRoutes) Setup

func (a SwaggerRoutes) Setup()

Setup swagger routes