ratelimiter

Documentation

Index

• type Config
• type ConfigPath
• type GinMiddleware
• type HTTPMessage
• type HTTPResp
• type Interface
  • func Init(cfg Config, log logger.Interface) Interface
• type Meta

Types

type Config

type Config struct {
	Enabled bool
	Period  string
	Limit   int64
	Paths   []ConfigPath
}

type ConfigPath

type ConfigPath struct {
	Enabled bool
	Period  string
	Limit   int64
	Path    string
}

type GinMiddleware

type GinMiddleware struct {
	*mgin.Middleware
}

type HTTPMessage

type HTTPMessage struct {
	Title string `json:"title"`
	Body  string `json:"body"`
}

type HTTPResp

type HTTPResp struct {
	Message HTTPMessage `json:"message"`
	Meta    Meta        `json:"metadata"`
}

type Interface

type Interface interface {
	Limiter() gin.HandlerFunc
}

func Init

func Init(cfg Config, log logger.Interface) Interface

type Meta

type Meta struct {
	Path       string `json:"path"`
	StatusCode int    `json:"statusCode"`
	Status     string `json:"status"`
	Message    string `json:"message"`
	Timestamp  string `json:"timestamp"`
}