http

Documentation

Index

• Variables
• func NewRouter(o *Options, logger *zap.Logger, init InitHandlers, tracer opentracing.Tracer) *gin.Engine
• type InitHandlers
• type Options
  • func NewOptions(v *viper.Viper) (*Options, error)
• type Server
  • func New(o *Options, logger *zap.Logger, router *gin.Engine) (*Server, error)
  • func (s *Server) Application(name, project, env string)
  • func (s *Server) Start() error
  • func (s *Server) Stop() error

Variables

var ProviderSet = wire.NewSet(New, NewRouter, NewOptions)

ProviderSet is a provider set for wire

Functions

func NewRouter

func NewRouter(o *Options, logger *zap.Logger, init InitHandlers, tracer opentracing.Tracer) *gin.Engine

NewRouter serve caller to create *gin.Engine

Types

type InitHandlers

type InitHandlers func(r *gin.Engine)

InitHandlers define register handler

type Options

type Options struct {
	Host string
	Port int
	Mode string
}

Options declare http's configuration

func NewOptions

func NewOptions(v *viper.Viper) (*Options, error)

NewOptions serve caller to create Options

type Server

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

Server declare http server

func New

func New(o *Options, logger *zap.Logger, router *gin.Engine) (*Server, error)

New serve caller to create Server

func (*Server) Application

func (s *Server) Application(name, project, env string)

Application serve caller set server's name

func (*Server) Start

func (s *Server) Start() error

Start serve caller to start server

func (*Server) Stop

func (s *Server) Stop() error

Stop serve caller to stop server