Documentation
¶
Index ¶
- func AutoGinApiRun(ctx context.Context, cfg *Config) error
- func AutoGinApiRunWithBindUser[T mid.BindUser](ctx context.Context, cfg *ConfigWithBindUser[T]) 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 (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 ConfigWithBindUser
- type GinAPI
- type GinAPIWithBindUser
- type GinApiHandler
- type GinApiServer
- type GinReqUserHandler
- type Log
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AutoGinApiRunWithBindUser ¶ added in v1.7.0
func GetPostValue ¶
func ParserDataRequest ¶
Types ¶
type Config ¶ added in v1.1.0
type Config struct {
Service string
GinMode string
IsMockAuth bool
MockAuthSecret string
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 ¶ added in v1.1.0
getConfig - Retrieves the configuration from the environment
func (*Config) AddProms ¶ added in v1.1.0
func (cfg *Config) AddProms(c ...prometheus.Collector)
func (*Config) SetAuth ¶ added in v1.1.0
func (cfg *Config) SetAuth(authmid auth.GinAuthMidInter)
func (*Config) SetMiddles ¶ added in v1.1.0
func (*Config) SetPreAuthMiddles ¶ added in v1.2.0
func (*Config) SetServerErrorHandler ¶ added in v1.1.0
func (cfg *Config) SetServerErrorHandler(handler errors.GinServerErrorHandler)
func (*Config) SetSessionStore ¶ added in v1.6.0
func (cfg *Config) SetSessionStore(store session.ManagerStore)
type ConfigWithBindUser ¶ added in v1.7.0
type ConfigWithBindUser[T mid.BindUser] struct { CtxUserKey string *Config // contains filtered or unexported fields }
func GetConfigWithBindUserFromEnv ¶ added in v1.7.0
func GetConfigWithBindUserFromEnv[T mid.BindUser](bind T) (*ConfigWithBindUser[T], error)
func (*ConfigWithBindUser[T]) SetAPIs ¶ added in v1.7.0
func (cfg *ConfigWithBindUser[T]) SetAPIs(apis ...GinAPIWithBindUser[T])
type GinAPI ¶
type GinAPI interface {
errors.ApiErrorHandler
GetAPIs() []*GinApiHandler
}
type GinAPIWithBindUser ¶ added in v1.7.0
type GinApiHandler ¶
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 GinReqUserHandler ¶ added in v1.7.0
func (*GinReqUserHandler[T]) GetReqUser ¶ added in v1.7.0
func (h *GinReqUserHandler[T]) GetReqUser(c *gin.Context) T
func (*GinReqUserHandler[T]) SetReqUserHandler ¶ added in v1.7.0
func (h *GinReqUserHandler[T]) SetReqUserHandler(ctxUserKey string)
Click to show internal directories.
Click to hide internal directories.