web

Documentation

Index

• func DefaultHealthHandler(c *gin.Context)
• func ErrCodeHandler(c *gin.Context)
• func FlagSet(defaultPort int) *pflag.FlagSet
• func RequestID(c *gin.Context) string
• func VersionHandler(info *Info) gin.HandlerFunc
• func ZapRequestID(c *gin.Context) zap.Field
• type Config
  • func (c *Config) Addr() string
  • func (c *Config) FlagSet(defaultPort int) *pflag.FlagSet
  • func (c *Config) GetEndpoint() string
  • func (s *Config) WithDebug(v bool) *Config
  • func (s *Config) WithEndpoint(v string) *Config
  • func (s *Config) WithHost(v string) *Config
  • func (s *Config) WithMetrics(v bool) *Config
  • func (s *Config) WithPort(v int) *Config
  • func (s *Config) WithPprof(v bool) *Config
  • func (s *Config) WithPrefix(v string) *Config
• type Handler
• type Info
• type Service
  • func New(conf *Config, info *Info, fn func(gin.IRouter)) *Service
  • func (s *Service) Build() *Service
  • func (s *Service) Close() error
  • func (s *Service) Engine() *gin.Engine
  • func (s *Service) Routes() []gin.RouteInfo
  • func (s *Service) Serve() error
  • func (s *Service) Server() *http.Server
  • func (s *Service) SetHealthzHandler(h gin.HandlerFunc)
  • func (s *Service) SetReadinessHandler(h gin.HandlerFunc)
  • func (s *Service) SetVersionHandler(h gin.HandlerFunc)
  • func (s *Service) Shutdown(ctx context.Context) error

Functions

func DefaultHealthHandler

func DefaultHealthHandler(c *gin.Context)

func ErrCodeHandler

func ErrCodeHandler(c *gin.Context)

func FlagSet

func FlagSet(defaultPort int) *pflag.FlagSet

func RequestID

func RequestID(c *gin.Context) string

func VersionHandler

func VersionHandler(info *Info) gin.HandlerFunc

func ZapRequestID

func ZapRequestID(c *gin.Context) zap.Field

Types

type Config

type Config struct {
	Prefix   string `json:"prefix" yaml:"prefix" default:"/"`
	Endpoint string `json:"endpoint" yaml:"endpoint"`
	Host     string `json:"host" yaml:"host" default:"127.0.0.1"`
	Port     int    `json:"port" yaml:"port"`
	Debug    bool   `json:"debug" yaml:"debug"`
	Pprof    bool   `json:"pprof" yaml:"pprof"`
	Metrics  bool   `json:"metrics" yaml:"metrics"`
}

func (*Config) Addr

func (c *Config) Addr() string

func (*Config) FlagSet

func (c *Config) FlagSet(defaultPort int) *pflag.FlagSet

func (*Config) GetEndpoint

func (c *Config) GetEndpoint() string

func (*Config) WithDebug

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

func (*Config) WithEndpoint

func (s *Config) WithEndpoint(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) 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

type Handler

type Handler interface {
	Register(gin.IRouter)
}

type Info

type Info struct {
	Name    string
	Version string
	Commit  string
	BuildAt string
}

type Service

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

func New

func New(conf *Config, info *Info, fn func(gin.IRouter)) *Service

func (*Service) Build

func (s *Service) Build() *Service

func (*Service) Close

func (s *Service) Close() error

func (*Service) Engine

func (s *Service) Engine() *gin.Engine

func (*Service) Routes

func (s *Service) Routes() []gin.RouteInfo

func (*Service) Serve

func (s *Service) Serve() error

func (*Service) Server

func (s *Service) Server() *http.Server

func (*Service) SetHealthzHandler

func (s *Service) SetHealthzHandler(h gin.HandlerFunc)

func (*Service) SetReadinessHandler

func (s *Service) SetReadinessHandler(h gin.HandlerFunc)

func (*Service) SetVersionHandler

func (s *Service) SetVersionHandler(h gin.HandlerFunc)

func (*Service) Shutdown

func (s *Service) Shutdown(ctx context.Context) error