server

Documentation

Index

• type BasicAuth
• type Handler
• type HealthCheck
• type Server
  • func NewServer(engine *gin.Engine, options []ServerOption) *Server
  • func (s *Server) Register(path string, handler Handler) error
  • func (s *Server) Start() error
• type ServerOption
  • func WithBasicAuth(auth BasicAuth) ServerOption
  • func WithGZIP() ServerOption
  • func WithLogging(logger *zap.Logger) ServerOption
  • func WithPort(port int) ServerOption
  • func WithProfiling() ServerOption
  • func WithRecovery() ServerOption

Types

type BasicAuth

type BasicAuth struct {
	Username string
	Password string
}

type Handler

type Handler interface {
	Register(group *gin.RouterGroup) error
}

type HealthCheck

type HealthCheck = func() error

type Server

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

func NewServer

func NewServer(engine *gin.Engine, options []ServerOption) *Server

func (*Server) Register

func (s *Server) Register(path string, handler Handler) error

func (*Server) Start

func (s *Server) Start() error

type ServerOption

type ServerOption func(s *Server) error

func WithBasicAuth

func WithBasicAuth(auth BasicAuth) ServerOption

func WithGZIP

func WithGZIP() ServerOption

func WithLogging

func WithLogging(logger *zap.Logger) ServerOption

func WithPort

func WithPort(port int) ServerOption

func WithProfiling

func WithProfiling() ServerOption

func WithRecovery

func WithRecovery() ServerOption