http

Documentation

Index

• Variables
• func AsControllerRoute(controller any) any
• func AsHandlerRoute(handler any) any
• type Config
• type ControllerRoute
• type HandlerRoute
• type Params
• type Result
  • func NewRouter(p Params) Result
  • func (r *Result) GetHttpRouter() *gin.Engine
• type SwaggerHandler
  • func NewSwaggerHandler() *SwaggerHandler
  • func (h *SwaggerHandler) GinHandler() gin.HandlerFunc
  • func (h *SwaggerHandler) RoutePattern() string

Variables

var Module = fx.Options(
	fx.Provide(newHttp),
	fx.Invoke(runHttpServer),
	fx.Provide(NewRouter),
	fx.Provide(NewSwaggerHandler),
)

Functions

func AsControllerRoute

func AsControllerRoute(controller any) any

func AsHandlerRoute

func AsHandlerRoute(handler any) any

Types

type Config

type Config struct {
	ListenAddr string `env:"LISTEN_ADDR, default=:8080"`
}

type ControllerRoute

type ControllerRoute interface {
	RegisterControllerRoutes(rg *gin.RouterGroup)
	RoutePattern() string
}

type HandlerRoute

type HandlerRoute interface {
	HttpHandler() http.Handler
	RoutePattern() string
}

type Params

type Params struct {
	fx.In
	Logger           *zap.SugaredLogger `optional:"true"`
	ControllerRoutes []ControllerRoute  `group:"controllerRoutes"`
	HandlerRoutes    []HandlerRoute     `group:"handlerRoutes"`
	SwaggerHandler   *SwaggerHandler
}

type Result

type Result struct {
	fx.Out
	Http *gin.Engine
}

func NewRouter

func NewRouter(p Params) Result

func (*Result) GetHttpRouter

func (r *Result) GetHttpRouter() *gin.Engine

type SwaggerHandler

type SwaggerHandler struct{}

func NewSwaggerHandler

func NewSwaggerHandler() *SwaggerHandler

func (*SwaggerHandler) GinHandler

func (h *SwaggerHandler) GinHandler() gin.HandlerFunc

func (*SwaggerHandler) RoutePattern

func (h *SwaggerHandler) RoutePattern() string