apitool

README

api-toolkit

Documentation

Index

• func AutoGinApiRun(ctx context.Context, cfg *Config) error
• func AutoGinApiServer(cfg *Config) (*http.Server, error)
• func GetHost(req *http.Request) string
• func GetPostValue(req *http.Request, defaultEmpty bool, keys []string) (map[string]interface{}, error)
• func ParserDataRequest(req *http.Request, data interface{}) error
• type Config
  • func GetConfigFromEnv() (*Config, error)
  • func (cfg *Config) AddProms(c ...prometheus.Collector)
  • func (cfg *Config) SetAPIs(apis ...GinAPI)
  • func (cfg *Config) SetAuth(authmid auth.GinAuthMidInter)
  • func (cfg *Config) SetMiddles(mids ...mid.GinMiddle)
  • func (cfg *Config) SetPreAuthMiddles(mids ...mid.GinMiddle)
  • func (cfg *Config) SetServerErrorHandler(handler errors.GinServerErrorHandler)
  • func (cfg *Config) SetSessionStore(store session.ManagerStore)
• type GinAPI
• type GinApiHandler
• type GinApiServer
  • func NewGinApiServer(mode string, service string) GinApiServer
• type Log

Functions

func AutoGinApiRun

func AutoGinApiRun(ctx context.Context, cfg *Config) error

func AutoGinApiServer

func AutoGinApiServer(cfg *Config) (*http.Server, error)

func GetHost

func GetHost(req *http.Request) string

func GetPostValue

func GetPostValue(req *http.Request, defaultEmpty bool, keys []string) (map[string]interface{}, error)

func ParserDataRequest

func ParserDataRequest(req *http.Request, data interface{}) error

Types

type Config

type Config struct {
	Service           string
	GinMode           string
	IsMockAuth        bool
	ApiPort           int
	TrustedProxies    []string
	Debug             bool // autopaho and paho debug output requested
	SessionHeaderName string
	SessionExpired    time.Duration

	Logger Log
	// contains filtered or unexported fields
}

config holds the configuration

func GetConfigFromEnv

func GetConfigFromEnv() (*Config, error)

getConfig - Retrieves the configuration from the environment

func (*Config) AddProms

func (cfg *Config) AddProms(c ...prometheus.Collector)

func (*Config) SetAPIs

func (cfg *Config) SetAPIs(apis ...GinAPI)

func (*Config) SetAuth

func (cfg *Config) SetAuth(authmid auth.GinAuthMidInter)

func (*Config) SetMiddles

func (cfg *Config) SetMiddles(mids ...mid.GinMiddle)

func (*Config) SetPreAuthMiddles

func (cfg *Config) SetPreAuthMiddles(mids ...mid.GinMiddle)

func (*Config) SetServerErrorHandler

func (cfg *Config) SetServerErrorHandler(handler errors.GinServerErrorHandler)

func (*Config) SetSessionStore

func (cfg *Config) SetSessionStore(store session.ManagerStore)

type GinAPI

type GinAPI interface {
	errors.ApiErrorHandler
	GetAPIs() []*GinApiHandler
}

type GinApiHandler

type GinApiHandler struct {
	Handler func(c *gin.Context)
	Method  string
	Path    string
	Auth    bool
	Group   []auth.ApiPerm
}

type GinApiServer

type GinApiServer interface {
	AddAPIs(handlers ...GinAPI) GinApiServer
	Middles(mids ...mid.GinMiddle) GinApiServer
	SetServerErrorHandler(errors.GinServerErrorHandler) GinApiServer
	SetAuth(authmid auth.GinAuthMidInter) GinApiServer
	SetTrustedProxies([]string) GinApiServer
	SetPromhttp(c ...prometheus.Collector) GinApiServer
	SetSession(sessionHeaderName string, store session.ManagerStore, expired time.Duration) GinApiServer
	Static(relativePath, root string) GinApiServer
	Run(port int) error

	GetServer(port int) *http.Server
	// contains filtered or unexported methods
}

func NewGinApiServer

func NewGinApiServer(mode string, service string) GinApiServer

type Log

type Log interface {
	Infof(format string, a ...any)
	Fatalf(format string, a ...any)
}