httpserver

Documentation

Index

• Constants
• func After(routes gin.IRoutes, after ...middleware.Middleware)
• func Before(routes gin.IRoutes, before ...middleware.Middleware)
• func Handle(routes gin.IRoutes, method string, path string, function interface{})
• func Route(routes gin.IRoutes, method string, path string, function interface{})
• type Config
• type Option
  • func WithMiddles(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

Functions

func After

func After(routes gin.IRoutes, after ...middleware.Middleware)

func Before

func Before(routes gin.IRoutes, before ...middleware.Middleware)

func Handle

func Handle(routes gin.IRoutes, method string, path string, function interface{})

func Route

func Route(routes gin.IRoutes, method string, path string, function interface{})

Types

type Config

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

type Option

type Option func(config *Config)

func WithMiddles

func WithMiddles(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
	GetEngine() (engine *gin.Engine)
	Run(ctx context.Context) error
	Close(ctx context.Context) error
	OnShutdown(shutdownHook hook.ShutdownHook) Server
	OnBeforeRun(hook.RunHook) Server
	Route(routes Router) Server
}

func NewServer

func NewServer(options ...Option) Server

func NewServerWithConfig

func NewServerWithConfig(config Config) Server