Cache user must pass getCacheKey to describe the way to generate cache key

CacheByRequestPath a shortcut function for caching response by url path, means will discard the query params

CacheByRequestURI a shortcut function for caching response by uri

type BeforeReplyWithCacheCallback func(c *gin.Context, cache *ResponseCache)

Config contains all options

Discard the default logger that will discard all logs of gin-cache

func (l Discard) Errorf(string, ...interface{})

GetCacheStrategyByRequest User can this function to design custom cache strategy by request. The first return value bool means whether this request should be cached. The second return value Strategy determine the special strategy by this request.

type Logger interface {
	Errorf(string, ...interface{})
}

Logger define the logger interface

OnHitCacheCallback define the callback when use cache

OnMissCacheCallback define the callback when use cache

type OnShareSingleFlightCallback func(c *gin.Context)

OnShareSingleFlightCallback define the callback when share the singleflight result

type Option func(c *Config)

Option represents the optional function.

func IgnoreQueryOrder() Option

func WithBeforeReplyWithCache(cb BeforeReplyWithCacheCallback) Option

func WithCacheStrategyByRequest(getGetCacheStrategyByRequest GetCacheStrategyByRequest) Option

func WithDiscardHeaders(headers []string) Option

func WithLogger(l Logger) Option

func WithOnHitCache(cb OnHitCacheCallback) Option

func WithOnMissCache(cb OnMissCacheCallback) Option

func WithOnShareSingleFlight(cb OnShareSingleFlightCallback) Option

func WithPrefixKey(prefix string) Option

func WithSingleFlightForgetTimeout(forgetTimeout time.Duration) Option

func WithoutHeader() Option

type ResponseCache struct {
	Status int
	Data   []byte
}

ResponseCache record the http response cache

Strategy the cache strategy