http

Documentation

Index

• func NewHTTPCmd(getServer InitializeServerFunc) *cobra.Command
• type InitializeServerFunc
• type Server
  • func NewServer(env xin.Envirment, config ServerConfig, service Service) *Server
  • func (s *Server) GetHTTPServer() (*http.Server, error)
• type ServerConfig
• type ServerInterface
• type Service

Functions

func NewHTTPCmd

func NewHTTPCmd(getServer InitializeServerFunc) *cobra.Command

NewHTTPCmd Get a cobra command start http server

Types

type InitializeServerFunc

type InitializeServerFunc func() (ServerInterface, error)

InitializeServerFunc function init http Server gives the posibility for dependence inject

type Server

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

Server Http server implement ServerInterface

func NewServer

func NewServer(env xin.Envirment, config ServerConfig, service Service) *Server

NewServer Create a new HTTP server

func (*Server) GetHTTPServer

func (s *Server) GetHTTPServer() (*http.Server, error)

GetHTTPServer ServerInterface implement

type ServerConfig

type ServerConfig interface {
	HTTPListen() string
}

ServerConfig config provide HTTP server setting

type ServerInterface

type ServerInterface interface {
	// provide the http server service
	GetHTTPServer() (*http.Server, error)
}

ServerInterface a server can provide http server

type Service

type Service interface {
	// register route and middleware into gin engine
	RegisterRouter(*gin.Engine) error
}

Service http service interface