ginx

Documentation

Index

• func CaptchaCheck(uuid, code string) bool
• func CaptchaHandler(c *gin.Context)
• func ErrCodeHandler(c *gin.Context)
• func FlagSet(defaultPort int) *pflag.FlagSet
• func LogMw(c *gin.Context)
• func New[T auth.IDType](conf *Config, routers Routers, mwBefore, mwAfter []gin.HandlerFunc) (*http.Server, error)
• type Config
  • func (s *Config) Commit() string
  • func (c *Config) GetAddr() string
  • func (c *Config) GetEndpoint() string
  • func (s *Config) Version() string
  • func (s *Config) WithAddr(v string) *Config
  • func (s *Config) WithAuth(v auth.Config) *Config
  • func (s *Config) WithCommit(v string) *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) 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
  • func (s *Config) WithVersion(v string) *Config
• type Controller
• type RegisterFunc
• type Routers
  • func (rs Routers) Apply(g *gin.RouterGroup)
  • func (rs *Routers) Register(f RegisterFunc)

Functions

func CaptchaCheck

func CaptchaCheck(uuid, code string) bool

func CaptchaHandler

func CaptchaHandler(c *gin.Context)

func ErrCodeHandler

func ErrCodeHandler(c *gin.Context)

func FlagSet

func FlagSet(defaultPort int) *pflag.FlagSet

func LogMw

func LogMw(c *gin.Context)

func New

func New[T auth.IDType](conf *Config, routers Routers, mwBefore, mwAfter []gin.HandlerFunc) (*http.Server, error)

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"`
	Addr      string      `json:"addr" yaml:"addr" 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" default:"true"`
	Metrics   bool        `json:"metrics" yaml:"metrics" default:"true"`
	Auth      auth.Config `json:"auth" yaml:"auth"`
	// contains filtered or unexported fields
}

func (*Config) Commit

func (s *Config) Commit() string

func (*Config) GetAddr

func (c *Config) GetAddr() string

func (*Config) GetEndpoint

func (c *Config) GetEndpoint() string

func (*Config) Version

func (s *Config) Version() string

func (*Config) WithAddr

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

func (*Config) WithAuth

func (s *Config) WithAuth(v auth.Config) *Config

func (*Config) WithCommit

func (s *Config) WithCommit(v string) *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) 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

func (*Config) WithVersion

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

type Controller

type Controller interface {
	Authed(*gin.RouterGroup)
	UnAuth(*gin.RouterGroup)
}

type RegisterFunc

type RegisterFunc func(*gin.RouterGroup)

type Routers

type Routers []RegisterFunc

func (Routers) Apply

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

func (*Routers) Register

func (rs *Routers) Register(f RegisterFunc)