ginserver

Documentation

Index

• Variables
• func Any(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
• func DELETE(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
• func GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
• func HEAD(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
• func OPTIONS(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
• func PATCH(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
• func POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
• func PUT(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
• func Run() error
• func ServeHTTP(w http.ResponseWriter, req *http.Request)
• func Use(middleware ...gin.HandlerFunc) gin.IRoutes
• type Config
  • func DefaultConfig(key string) *Config
  • func StdConfig(key string) *Config
  • func (c *Config) Build() *GinServer
  • func (c *Config) Path() string
• type Context
• type GinServer
  • func (server *GinServer) Any(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
  • func (server *GinServer) DELETE(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
  • func (server *GinServer) GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
  • func (server *GinServer) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup
  • func (server *GinServer) HEAD(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
  • func (server *GinServer) Name() string
  • func (server *GinServer) OPTIONS(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
  • func (server *GinServer) PATCH(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
  • func (server *GinServer) POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
  • func (server *GinServer) PUT(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
  • func (server *GinServer) RoutesInfo() gin.RoutesInfo
  • func (server *GinServer) Run() error
  • func (server *GinServer) Serve(ctx context.Context) error
  • func (server *GinServer) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (server *GinServer) Shutdown(ctx context.Context) error
  • func (server *GinServer) Use(middleware ...gin.HandlerFunc) gin.IRoutes
• type HandlerFunc
• type RouterGroup

Variables

var (
	Default = StdConfig("default").Build()
)

Functions

func Any

func Any(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func DELETE

func DELETE(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func GET

func GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func HEAD

func HEAD(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func OPTIONS

func OPTIONS(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func PATCH

func PATCH(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func POST

func POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func PUT

func PUT(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func Run

func Run() error

func ServeHTTP

func ServeHTTP(w http.ResponseWriter, req *http.Request)

func Use

func Use(middleware ...gin.HandlerFunc) gin.IRoutes

Types

type Config

type Config struct {
	Mode         string            `config:"mode" desc:"Gin mode: debug,release,test. default is release"`
	Addr         string            `config:"addr" desc:"server listen addr, format is ip:port"`
	BasicAuth    map[string]string `config:"basicAuth" desc:"basicAuth. key is username, value is password"`
	ReadTimeout  time.Duration     `config:"readTimeout"`
	WriteTimeout time.Duration     `config:"writeTimeout"`
	IdleTimeout  time.Duration     `config:"idleTimeout"`
	// contains filtered or unexported fields
}

func DefaultConfig

func DefaultConfig(key string) *Config

func StdConfig

func StdConfig(key string) *Config

func (*Config) Build

func (c *Config) Build() *GinServer

func (*Config) Path

func (c *Config) Path() string

type Context

type Context = gin.Context

type GinServer

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

func (*GinServer) Any

func (server *GinServer) Any(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func (*GinServer) DELETE

func (server *GinServer) DELETE(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func (*GinServer) GET

func (server *GinServer) GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func (*GinServer) Group

func (server *GinServer) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup

func (*GinServer) HEAD

func (server *GinServer) HEAD(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func (*GinServer) Name

func (server *GinServer) Name() string

func (*GinServer) OPTIONS

func (server *GinServer) OPTIONS(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func (*GinServer) PATCH

func (server *GinServer) PATCH(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func (*GinServer) POST

func (server *GinServer) POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func (*GinServer) PUT

func (server *GinServer) PUT(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func (*GinServer) RoutesInfo

func (server *GinServer) RoutesInfo() gin.RoutesInfo

func (*GinServer) Run

func (server *GinServer) Run() error

func (*GinServer) Serve

func (server *GinServer) Serve(ctx context.Context) error

func (*GinServer) ServeHTTP

func (server *GinServer) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*GinServer) Shutdown

func (server *GinServer) Shutdown(ctx context.Context) error

func (*GinServer) Use

func (server *GinServer) Use(middleware ...gin.HandlerFunc) gin.IRoutes

type HandlerFunc

type HandlerFunc = gin.HandlerFunc

type RouterGroup

type RouterGroup = gin.RouterGroup