frame

Documentation

Index

• func RegisterSwagger(addr string, engine *gin.Engine)
• type DefaultWeb
  • func (slf *DefaultWeb) Engine() *gin.Engine
  • func (slf *DefaultWeb) Shutdown()
  • func (slf *DefaultWeb) Start() error
  • func (slf *DefaultWeb) WithStart(f func(IMagicWeb) error)
• type IMagicWeb
• type Spawn

Functions

func RegisterSwagger

func RegisterSwagger(addr string, engine *gin.Engine)

RegisterSwagger register swagger service

Types

type DefaultWeb

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

DefaultWeb doc @Struct DefaultWeb @Summary Default web framework

func (*DefaultWeb) Engine

func (slf *DefaultWeb) Engine() *gin.Engine

Engine doc @Summary Returns gin engine

func (*DefaultWeb) Shutdown

func (slf *DefaultWeb) Shutdown()

Shutdown doc @Summary shutdown system

func (*DefaultWeb) Start

func (slf *DefaultWeb) Start() error

Start doc @Summary start system @Return (error) start fail returns error

func (*DefaultWeb) WithStart

func (slf *DefaultWeb) WithStart(f func(IMagicWeb) error)

WithStart doc @Summary job start function to frame @Param (func()error)

type IMagicWeb

type IMagicWeb interface {
	Start() error
	Shutdown()
	Engine() *gin.Engine
}

IMagicWeb doc @Method IMagicWeb @Summary eb system main frame

type Spawn

type Spawn func() IMagicWeb

Spawn doc @type Spawn @Summary Create agic web framework function