api

Documentation

Index

• type Config
  • func (c *Config) Server(logger *zap.Logger) (*Server, *v1.ServerManager, error)
• type Server
  • func (s *Server) Start(ctx context.Context) error
  • func (s *Server) Stop() error
  • func (s *Server) String() string

Types

type Config

type Config struct {
	Enabled bool `json:"enabled"`

	// Debug
	DebugPprof bool `json:"debugPprof"`

	// Reverse proxy
	EnableTrustedProxyCheck bool     `json:"enableTrustedProxyCheck"`
	TrustedProxies          []string `json:"trustedProxies"`
	ProxyHeader             string   `json:"proxyHeader"`

	// Listen
	Listen         string `json:"listen"`
	CertFile       string `json:"certFile"`
	KeyFile        string `json:"keyFile"`
	ClientCertFile string `json:"clientCertFile"`

	// Misc
	SecretPath      string `json:"secretPath"`
	FiberConfigPath string `json:"fiberConfigPath"`
}

Config stores the configuration for the RESTful API.

func (*Config) Server

func (c *Config) Server(logger *zap.Logger) (*Server, *v1.ServerManager, error)

Server returns a new API server from the config.

type Server

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

Server is the RESTful API server.

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

Start starts the API server.

func (*Server) Stop

func (s *Server) Stop() error

Stop stops the API server.

func (*Server) String

func (s *Server) String() string

String implements the service.Service String method.