web

Documentation

Index

• func CaptchaHandler(debug bool) gin.HandlerFunc
• func ErrCodeHandler(c *gin.Context)
• func FlagSet(defaultPort int) *pflag.FlagSet
• func New(conf *Config, router *Routers, mwBefore, mwAfter []gin.HandlerFunc) (*http.Server, error)
• func Routes() []gin.RouteInfo
• func SetVersionHandler(version, commit string)
• type Config
  • func (c *Config) Addr() string
  • func (c *Config) Check() *Config
  • func (c *Config) GetEndpoint() string
  • func (s *Config) WithAuth(v bool) *Config
  • func (s *Config) WithDebug(v bool) *Config
  • func (s *Config) WithEndpoint(v string) *Config
  • func (s *Config) WithHeaders(v []string) *Config
  • func (s *Config) WithHost(v string) *Config
  • func (s *Config) WithMetrics(v bool) *Config
  • func (s *Config) WithOrigins(v []string) *Config
  • func (s *Config) WithPort(v int) *Config
  • func (s *Config) WithPprof(v bool) *Config
  • func (s *Config) WithPrefix(v string) *Config
  • func (s *Config) WithRequestID(v bool) *Config
  • func (s *Config) WithSystem(v string) *Config
• type RegisterFunc
• type Routers
  • func NewRouters() *Routers
  • func (rs Routers) Apply(g *gin.RouterGroup)
  • func (rs *Routers) Handle(method, path string, f gin.HandlerFunc)
  • func (rs *Routers) Register(f RegisterFunc)

Functions

func CaptchaHandler

func CaptchaHandler(debug bool) gin.HandlerFunc

func ErrCodeHandler

func ErrCodeHandler(c *gin.Context)

func FlagSet

func FlagSet(defaultPort int) *pflag.FlagSet

func New

func New(conf *Config, router *Routers, mwBefore, mwAfter []gin.HandlerFunc) (*http.Server, error)

func Routes

func Routes() []gin.RouteInfo

func SetVersionHandler

func SetVersionHandler(version, commit string)

Types

type Config

type Config struct {
	System    string   `json:"system" yaml:"system"`
	Prefix    string   `json:"prefix" yaml:"prefix" default:"/api"`
	Endpoint  string   `json:"endpoint" yaml:"endpoint"`
	Host      string   `json:"host" yaml:"host" default:"127.0.0.1"`
	Port      int      `json:"port" yaml:"port" default:"8080"`
	Origins   []string `json:"origins" yaml:"origins"`
	Headers   []string `json:"headers" yaml:"headers"`
	Debug     bool     `json:"debug" yaml:"debug"`
	Pprof     bool     `json:"pprof" yaml:"pprof"`
	RequestID bool     `json:"requestid" yaml:"requestid"`
	Metrics   bool     `json:"metrics" yaml:"metrics"`
	Auth      bool     `json:"auth" yaml:"auth"`
}

func (*Config) Addr

func (c *Config) Addr() string

func (*Config) Check

func (c *Config) Check() *Config

func (*Config) GetEndpoint

func (c *Config) GetEndpoint() string

func (*Config) WithAuth

func (s *Config) WithAuth(v bool) *Config

func (*Config) WithDebug

func (s *Config) WithDebug(v bool) *Config

func (*Config) WithEndpoint

func (s *Config) WithEndpoint(v string) *Config

func (*Config) WithHeaders

func (s *Config) WithHeaders(v []string) *Config

func (*Config) WithHost

func (s *Config) WithHost(v string) *Config

func (*Config) WithMetrics

func (s *Config) WithMetrics(v bool) *Config

func (*Config) WithOrigins

func (s *Config) WithOrigins(v []string) *Config

func (*Config) WithPort

func (s *Config) WithPort(v int) *Config

func (*Config) WithPprof

func (s *Config) WithPprof(v bool) *Config

func (*Config) WithPrefix

func (s *Config) WithPrefix(v string) *Config

func (*Config) WithRequestID

func (s *Config) WithRequestID(v bool) *Config

func (*Config) WithSystem

func (s *Config) WithSystem(v string) *Config

type RegisterFunc

type RegisterFunc func(*gin.RouterGroup)

type Routers

type Routers []RegisterFunc

func NewRouters

func NewRouters() *Routers

func (Routers) Apply

func (rs Routers) Apply(g *gin.RouterGroup)

func (*Routers) Handle

func (rs *Routers) Handle(method, path string, f gin.HandlerFunc)

func (*Routers) Register

func (rs *Routers) Register(f RegisterFunc)