wrap

package module

v0.0.0-...-37b9b94 Latest Latest Go to latest Published: Aug 10, 2022 License: GPL-3.0 Imports: 23 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/d2jvkpn/go-web

Documentation ¶

Overview ¶

Third Party Packags: - github.com/gin-gonic/gin - github.com/spf13/viper

- go.uber.org/multierr - go.uber.org/zap - go.uber.org/zap/zapcore - gopkg.in/natefinch/lumberjack.v2

- github.com/prometheus/client_golang/prometheus - github.com/prometheus/client_golang/prometheus/promauto - github.com/prometheus/client_golang/prometheus/promhttp

Index ¶

func CacheControl(seconds int) gin.HandlerFunc
func Cors(origin string) gin.HandlerFunc
func GetAddr(ctx *gin.Context) (ap netip.AddrPort, err error)
func GetAddrString(ctx *gin.Context) string
func GetCtxValue[T any](ctx *gin.Context, key string) (v T, ok bool)
func GinJwtHSAuth(auth *JwtHSAuth, handle func(*gin.Context, map[string]any) error) gin.HandlerFunc
func Healthy(ctx *gin.Context)
func LoadConfigFile(name, fp string) (conf *viper.Viper, err error)
func LoadConfigString(name, str, typ string) (conf *viper.Viper, err error)
func NewPrometheusMonitor(namespace string) gin.HandlerFunc
func Pprof(rg *gin.RouterGroup, handlers ...gin.HandlerFunc)
func PrometheusFunc(ctx *gin.Context)
func ReadConfigField(name, fp, sp string) (out string, err error)
func ServeFavicon(bts []byte, ts ...time.Time) gin.HandlerFunc
func UnmarshalConfigFile(name, fp string, objects map[string]any) (err error)
func WriteJSON(ctx *gin.Context, bts []byte) (int, error)
func WsUpgrade(ctx *gin.Context)
type JwtHSAuth
- func NewHSAuth(key string, code uint) (auth *JwtHSAuth, err error)
- func (auth *JwtHSAuth) Parse(str string) (data map[string]any, err error)
- func (auth *JwtHSAuth) Sign(data map[string]any) (str string, err error)
type JwtRSAAuth
- func NewRSAAuth(privateKeyFile, publicKeyFile string, code uint) (auth *JwtRSAAuth, err error)
- func (auth *JwtRSAAuth) Parse(str string) (data map[string]any, err error)
- func (auth *JwtRSAAuth) Sign(data map[string]any) (str string, err error)
type Logger
- func NewLogger(filename string, level zapcore.LevelEnabler, mbs int, w io.Writer, ...) (logger *Logger)
- func (logger *Logger) Down() (err error)
type StaticDir
- func ServeStatic(dir, local string, listDir bool) StaticDir

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CacheControl ¶

func CacheControl(seconds int) gin.HandlerFunc

func Cors ¶

func Cors(origin string) gin.HandlerFunc

func GetAddr ¶

func GetAddr(ctx *gin.Context) (ap netip.AddrPort, err error)

func GetAddrString ¶

func GetAddrString(ctx *gin.Context) string

func GetCtxValue ¶

func GetCtxValue[T any](ctx *gin.Context, key string) (v T, ok bool)

func GinJwtHSAuth ¶

func GinJwtHSAuth(auth *JwtHSAuth, handle func(*gin.Context, map[string]any) error,
) gin.HandlerFunc

func Healthy ¶

func Healthy(ctx *gin.Context)

func LoadConfigFile ¶

func LoadConfigFile(name, fp string) (conf *viper.Viper, err error)

func LoadConfigString ¶

func LoadConfigString(name, str, typ string) (conf *viper.Viper, err error)

func NewPrometheusMonitor ¶

func NewPrometheusMonitor(namespace string) gin.HandlerFunc

demo

func Pprof ¶

func Pprof(rg *gin.RouterGroup, handlers ...gin.HandlerFunc)

func PrometheusFunc ¶

func PrometheusFunc(ctx *gin.Context)

func ReadConfigField ¶

func ReadConfigField(name, fp, sp string) (out string, err error)

func ServeFavicon ¶

func ServeFavicon(bts []byte, ts ...time.Time) gin.HandlerFunc

https://github.com/thinkerou/favicon/blob/master/favicon.go

func UnmarshalConfigFile ¶

func UnmarshalConfigFile(name, fp string, objects map[string]any) (err error)

func WriteJSON ¶

func WriteJSON(ctx *gin.Context, bts []byte) (int, error)

func WsUpgrade ¶

func WsUpgrade(ctx *gin.Context)

Types ¶

type JwtHSAuth ¶

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

func NewHSAuth ¶

func NewHSAuth(key string, code uint) (auth *JwtHSAuth, err error)

func (*JwtHSAuth) Parse ¶

func (auth *JwtHSAuth) Parse(str string) (data map[string]any, err error)

func (*JwtHSAuth) Sign ¶

func (auth *JwtHSAuth) Sign(data map[string]any) (str string, err error)

type JwtRSAAuth ¶

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

func NewRSAAuth ¶

func NewRSAAuth(privateKeyFile, publicKeyFile string, code uint) (auth *JwtRSAAuth, err error)

func (*JwtRSAAuth) Parse ¶

func (auth *JwtRSAAuth) Parse(str string) (data map[string]any, err error)

func (*JwtRSAAuth) Sign ¶

func (auth *JwtRSAAuth) Sign(data map[string]any) (str string, err error)

type Logger ¶

type Logger struct {
	Writer *lumberjack.Logger

	*zap.Logger
	// contains filtered or unexported fields
}

func NewLogger ¶

func NewLogger(filename string, level zapcore.LevelEnabler, mbs int, w io.Writer,
	skips ...int) (logger *Logger)

func (*Logger) Down ¶

func (logger *Logger) Down() (err error)

type StaticDir ¶

type StaticDir func(*gin.RouterGroup) error

func ServeStatic ¶

func ServeStatic(dir, local string, listDir bool) StaticDir

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL