zmidd

package module

v0.0.6 Latest Latest Go to latest Published: Apr 20, 2023 License: MIT Imports: 18 Imported by: 0

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/zohu/zmidd

Links

Open Source Insights

README ¶

zmidd

some gin middleware

Usage

Cors

func main() {
    s := gin.New()
    // default: *
    s.Use(zmidd.Cors())
    
    // options
    s.Use(zmidd.Cors(
        zmidd.WithAllowOrigin("*"),
        zmidd.WithAllowMethods("*"),
        zmidd.WithAllowHeaders("*"),
        zmidd.WithAllowCredentials("*"),
        zmidd.WithExposeHeaders("true"),
    ))
}

RequestId

func main() {
    s := gin.New()
    s.Use(zmidd.RequestId())
    
    // Get RequestId
    // c = *gin.Context
    rid := zmidd.GetRequestId(c)
}

Documentation ¶

Index ¶

Constants
func Cors(_ ...Option) gin.HandlerFunc
func GetRequestId(c *gin.Context) string
func Logger(conf LoggerConfig, whitelist []string) gin.HandlerFunc
func RateLimiter(rate float64) gin.HandlerFunc
func Recover() gin.HandlerFunc
func RequestId() gin.HandlerFunc
func SizeLimiter(size int64) gin.HandlerFunc
func Timeout(timeout time.Duration, whitelist []string) gin.HandlerFunc
type CustomResponseWriter
- func (w CustomResponseWriter) Write(b []byte) (int, error)
- func (w CustomResponseWriter) WriteString(s string) (int, error)
type LogLinkField
type LoggerConfig
type Option
type Options
type SimpleBodyWriter
- func (w SimpleBodyWriter) Write(b []byte) (int, error)

Constants ¶

View Source

const (
	DefaultAllowOrigin      = "*"
	DefaultAllowMethods     = "*"
	DefaultAllowHeaders     = "*"
	DefaultAllowCredentials = "*"
	DefaultExposeHeaders    = "true"
)

Variables ¶

This section is empty.

Functions ¶

func Cors ¶

func Cors(_ ...Option) gin.HandlerFunc

Cors @Description: 开启跨域控制 @Param ops: *Options 可选参数可以设置跨域的配置默认值为* 允许所有域名访问允许所有请求方法跨域允许所有请求头允许跨域携带cookie @Return gin.HandlerFunc 返回一个gin.HandlerFunc 可以直接使用gin.Use(Cors()) 或者在路由中使用Cors() 即可如果需要设置跨域的配置可以使用 WithAllowOrigin WithAllowMethods WithAllowHeaders WithAllowCredentials WithExposeHeaders

func GetRequestId ¶

func GetRequestId(c *gin.Context) string

func Logger ¶

func Logger(conf LoggerConfig, whitelist []string) gin.HandlerFunc

func RateLimiter ¶

func RateLimiter(rate float64) gin.HandlerFunc

RateLimiter @Description: 请求速率限制 @return gin.HandlerFunc

func Recover ¶

func Recover() gin.HandlerFunc

func RequestId ¶

func RequestId() gin.HandlerFunc

func SizeLimiter ¶

func SizeLimiter(size int64) gin.HandlerFunc

SizeLimiter @Description: 请求体大小限制 @return gin.HandlerFunc

func Timeout ¶

func Timeout(timeout time.Duration, whitelist []string) gin.HandlerFunc

Timeout @Description: 超时中间件 @param timeout @param whitelist @return gin.HandlerFunc

Types ¶

type CustomResponseWriter ¶

type CustomResponseWriter struct {
	gin.ResponseWriter
	// contains filtered or unexported fields
}

func (CustomResponseWriter) Write ¶

func (w CustomResponseWriter) Write(b []byte) (int, error)

func (CustomResponseWriter) WriteString ¶

func (w CustomResponseWriter) WriteString(s string) (int, error)

type LogLinkField ¶

type LogLinkField struct {
	Rid   string `json:"rid"`
	Time  int64  `json:"time"`
	Delay int64  `json:"delay"`
	Tag   string `json:"tag"`
	Auth  string `json:"auth"`
	Head  string `json:"head"`
	Param string `json:"param"`
	Data  string `json:"data"`
	Error string `json:"error"`
}

type LoggerConfig ¶

type LoggerConfig struct {
	LogTag      string `yaml:"log_tag" mapstructure:"log_tag"`
	MaxBody     int    `yaml:"max_body" mapstructure:"max_body"`
	MaxResponse int    `yaml:"max_response" mapstructure:"max_response"`
	MaxFile     uint   `yaml:"max_file" mapstructure:"max_file"`
	Path        string `yaml:"path" mapstructure:"path"`
	PrintThird  bool   `yaml:"print_third" mapstructure:"print_third"`
}

type Option ¶

type Option func(s string) *Options

type Options ¶

type Options struct {
	AllowOrigin      string
	AllowMethods     string
	AllowHeaders     string
	AllowCredentials string
	ExposeHeaders    string
}

func WithAllowCredentials ¶

func WithAllowCredentials(allowCredentials string) *Options

func WithAllowHeaders ¶

func WithAllowHeaders(allowHeaders string) *Options

func WithAllowMethods ¶

func WithAllowMethods(allowMethods string) *Options

func WithAllowOrigin ¶

func WithAllowOrigin(allowOrigin string) *Options

func WithExposeHeaders ¶

func WithExposeHeaders(exposeHeaders string) *Options

type SimpleBodyWriter ¶

type SimpleBodyWriter struct {
	gin.ResponseWriter
	// contains filtered or unexported fields
}

func (SimpleBodyWriter) Write ¶

func (w SimpleBodyWriter) Write(b []byte) (int, error)

Source Files ¶

View all Source files

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