httpserver

Documentation

Index

• Constants
• type Config
• type Option
  • func WithMiddlewares(middlewares ...middleware.Middleware) Option
  • func WithMode(mode string) Option
  • func WithName(name string) Option
  • func WithPort(port int) Option
• type Router
• type Server
  • func NewServer(options ...Option) Server
  • func NewServerWithConfig(config Config) Server

Constants

const ModeDebug = gin.DebugMode

const ModeRelease = gin.ReleaseMode

const ModeTest = gin.TestMode

Types

type Config

type Config struct {
	Mode string `mapstructure:"mode" json:"mode"`
	Name string `mapstructure:"name" json:"name"`
	Port int    `mapstructure:"port" json:"port"`
	// contains filtered or unexported fields
}

type Option

type Option func(config *Config)

func WithMiddlewares

func WithMiddlewares(middlewares ...middleware.Middleware) Option

func WithMode

func WithMode(mode string) Option

func WithName

func WithName(name string) Option

func WithPort

func WithPort(port int) Option

type Router

type Router func(engine *gin.Engine)

type Server

type Server interface {
	Name() (name string)
	AddMiddlewares(middlewares ...middleware.Middleware) Server
	Kernel() (engine *gin.Engine)
	Run(ctx context.Context) error
	Close(ctx context.Context) error
	OnShutdown(shutdownHook hook.ShutdownHook) Server
	OnBeforeRun(hook.RunHook) Server
	Routes(routes Router) Server
}

func NewServer

func NewServer(options ...Option) Server

func NewServerWithConfig

func NewServerWithConfig(config Config) Server