gin

Documentation

Index

• type Config
• type Controller
• type DefaultRouter
  • func (r DefaultRouter) Init(engine *gin.Engine)
  • func (r *DefaultRouter) RegisterController(c Controller)
• type Entry
  • func NewEntry(conf *Config, router Router, logger *zap.Logger) *Entry
  • func (e *Entry) Engine() *gin.Engine
  • func (e *Entry) Run() error
  • func (e *Entry) Stop(ctx context.Context) error
• type Router

Types

type Config

type Config struct {
	Mod  string `yaml:"mod"`
	Addr string `yaml:"addr"`
}

type Controller

type Controller interface {
	RegisterRoute(engine *gin.RouterGroup)
}

type DefaultRouter

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

func (DefaultRouter) Init

func (r DefaultRouter) Init(engine *gin.Engine)

func (*DefaultRouter) RegisterController

func (r *DefaultRouter) RegisterController(c Controller)

type Entry

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

func NewEntry

func NewEntry(conf *Config, router Router, logger *zap.Logger) *Entry

func (*Entry) Engine

func (e *Entry) Engine() *gin.Engine

func (*Entry) Run

func (e *Entry) Run() error

func (*Entry) Stop

func (e *Entry) Stop(ctx context.Context) error

type Router

type Router interface {
	Init(engine *gin.Engine)
	RegisterController(c Controller)
}