server

Documentation

Index

• type CertKey
• type GenericAPIServer
  • func (s GenericAPIServer) Close()
  • func (s *GenericAPIServer) InstallAPIs()
  • func (s *GenericAPIServer) InstallMiddlewares()
  • func (s *GenericAPIServer) Run() error
  • func (s *GenericAPIServer) Setup()
• type HttpInfo
  • func (s *HttpInfo) Address() string
• type HttpsInfo
  • func (s *HttpsInfo) Address() string
• type JwtInfo
• type ServerConfig
  • func NewServerConfig() *ServerConfig
  • func (c *ServerConfig) NewAndInitApiServer() *GenericAPIServer

Types

type CertKey

type CertKey struct {
	CertFile string // 证书位置名
	KeyFile  string // 证书文件名
}

type GenericAPIServer

type GenericAPIServer struct {
	HttpsInfo *HttpsInfo // https

	HttpInfo *HttpInfo // http

	// ShutdownTimeout是用于关闭服务器的超时。这指定服务器运行之前的超时优雅地关机返回。
	ShutdownTimeout time.Duration

	*gin.Engine
	// contains filtered or unexported fields
}

给 http和https构建好应用 返回 外部直接使用

func (GenericAPIServer) Close

func (s GenericAPIServer) Close()

close

func (*GenericAPIServer) InstallAPIs

func (s *GenericAPIServer) InstallAPIs()

健康检查API gin.

func (*GenericAPIServer) InstallMiddlewares

func (s *GenericAPIServer) InstallMiddlewares()

加载需要加载的中间件

func (*GenericAPIServer) Run

func (s *GenericAPIServer) Run() error

根据 http 和 https 参数 进行构建运行服务 后

func (*GenericAPIServer) Setup

func (s *GenericAPIServer) Setup()

加载gin相关内容 安装程序

type HttpInfo

type HttpInfo struct {
	Addr string
	Port int
}

func (*HttpInfo) Address

func (s *HttpInfo) Address() string

type HttpsInfo

type HttpsInfo struct {
	Addr string
	Port int
	CertKey
}

func (*HttpsInfo) Address

func (s *HttpsInfo) Address() string

构建 "0.0.0.0:8080/443"

type JwtInfo

type JwtInfo struct {
	// defaults to "iam jwt"
	Realm string
	// defaults to empty
	Key string
	// defaults to one hour
	Timeout time.Duration
	// defaults to zero
	MaxRefresh time.Duration
}

type ServerConfig

type ServerConfig struct {
	HttpsInfo       *HttpsInfo
	HttpInfo        *HttpInfo
	Jwt             *JwtInfo
	Mode            string // gin.Mode
	Middlewares     []string
	Healthz         bool
	EnableProfiling bool
	EnableMetrics   bool
}

Config是用于配置GenericAPIServer的结构。

func NewServerConfig

func NewServerConfig() *ServerConfig

func (*ServerConfig) NewAndInitApiServer

func (c *ServerConfig) NewAndInitApiServer() *GenericAPIServer

根据配置进行应用