limiter

README

go-http-rate-limiter

Documentation

Index

• Variables
• type GeneralLimitConfiguration
• type LimitConfiguration
• type Limiter
  • func CreateRedisRateLimiter(ctx context.Context, name string, r *redis.Client, ...) Limiter

Variables

var (
	ErrLimitExceeded = errors.New("limit exceeded")
)

Types

type GeneralLimitConfiguration

type GeneralLimitConfiguration struct {
	LimitConfiguration
	EndpointsConfigurations map[string]LimitConfiguration
}

type LimitConfiguration

type LimitConfiguration struct {
	RequestLimit uint32        `json:"limit"`
	Duration     time.Duration `json:"duration"`
}

type Limiter

type Limiter interface {
	LimitHandler(next http.Handler) http.Handler
	CheckLimitFromRequest(r *http.Request) error
}

func CreateRedisRateLimiter

func CreateRedisRateLimiter(ctx context.Context, name string, r *redis.Client, configurations map[uint32]GeneralLimitConfiguration,
	getKeyTypeFunc func(r *http.Request) (string, uint32)) Limiter