gm

README

Gin Middleware Extension

Gin-Middleware is a middleware extension of the Gin framework in Go, including common functions such as guards, pipes, interceptors, etc.

key features are:

• guard
  • AuthGuard
• pipe
  • QueryPipe
  • BodyPipe
  • UserAgentPipe
• alarm
  • LogAlarm

Getting started

Prerequisites

Gin requires Go version 1.21 or above.

Getting Gin-Middleware

With Go's module support, go [build|run|test] automatically fetches the necessary dependencies when you add the import in your code:

import "github.com/zhangyuan722/gin-middleware"

Alternatively, use go get:

go get -u github.com/zhangyuan722/gin-middleware@latest

Test

go test -v

Documentation

Index

• Constants
• func AuthGuard(p *AuthGuardPayload) gin.HandlerFunc
• func BodyPipe[T any]() gin.HandlerFunc
• func GenerateToken(claims Claims, secretKey string) (string, error)
• func LogAlarm(p *LogAlarmPayload) gin.HandlerFunc
• func QueryPipe[T any]() gin.HandlerFunc
• func UserAgentPipe() gin.HandlerFunc
• type AlarmTrigger
• type AuthGuardPayload
• type Claims
  • func ParseToken(tokenString string, secretKey string) (*Claims, error)
• type LogAlarmPayload
• type NumericDate
  • func NewNumericDate(t time.Time) *NumericDate

Constants

const (
	CtxQuery = "query"
	CtxBody  = "body"

	CtxBrowserName = "browserName"
	CtxDeviceType  = "deviceType"
	CtxOSName      = "osName"
	CtxOSVersion   = "osVersion"
)

const (
	DeviceTypeDesktop = "desktop"
	DeviceTypeMobile  = "mobile"
	DeviceTypeTablet  = "tablet"
	DeviceTypeBot     = "bot"
	DeviceTypeUnknown = "unknown"
)

const (
	CtxClaims = "claims"
)

Functions

func AuthGuard

func AuthGuard(p *AuthGuardPayload) gin.HandlerFunc

AuthGuard http router 判断当前请求权限

path 在白名单时跳过验证，可用“*”模糊匹配

func BodyPipe

func BodyPipe[T any]() gin.HandlerFunc

func GenerateToken

func GenerateToken(claims Claims, secretKey string) (string, error)

func LogAlarm

func LogAlarm(p *LogAlarmPayload) gin.HandlerFunc

func QueryPipe

func QueryPipe[T any]() gin.HandlerFunc

func UserAgentPipe

func UserAgentPipe() gin.HandlerFunc

Types

type AlarmTrigger

type AlarmTrigger struct {
	WebHook []string
}

type AuthGuardPayload

type AuthGuardPayload struct {
	RequestHeaderAuthKey string
	WhiteList            []string

	SecretKey string

	CallBack func(c *gin.Context, claims *Claims, accessToken string)
	FailBack func(c *gin.Context, code int, msg string, data any)
}

type Claims

type Claims = jwt.RegisteredClaims

func ParseToken

func ParseToken(tokenString string, secretKey string) (*Claims, error)

type LogAlarmPayload

type LogAlarmPayload struct {
	Trigger AlarmTrigger
	Params  []string
}

type NumericDate

type NumericDate = jwt.NumericDate

func NewNumericDate

func NewNumericDate(t time.Time) *NumericDate