Categorygithub.com/gin-contrib/cache
modulepackage
1.3.1
Repository: https://github.com/gin-contrib/cache.git
Documentation: pkg.go.dev

# README

Cache gin's middleware

Build Status codecov Go Report Card GoDoc

Gin middleware/handler to enable Cache.

Usage

Start using it

Download and install it:

$ go get github.com/gin-contrib/cache

Import it in your code:

import "github.com/gin-contrib/cache"

Canonical example:

See the example

package main

import (
	"fmt"
	"time"

	"github.com/gin-contrib/cache"
	"github.com/gin-contrib/cache/persistence"
	"github.com/gin-gonic/gin"
)

func main() {
	r := gin.Default()

	store := persistence.NewInMemoryStore(time.Second)
	
	r.GET("/ping", func(c *gin.Context) {
		c.String(200, "pong "+fmt.Sprint(time.Now().Unix()))
	})
	// Cached Page
	r.GET("/cache_ping", cache.CachePage(store, time.Minute, func(c *gin.Context) {
		c.String(200, "pong "+fmt.Sprint(time.Now().Unix()))
	}))

	// Listen and Server in 0.0.0.0:8080
	r.Run(":8080")
}

# Packages

# Functions

Cache Middleware.
CachePage Decorator.
CachePageAtomic Decorator.
CachePageWithoutQuery add ability to ignore GET query parameters.
CreateKey creates a package specific key for a given string.
RegisterResponseCacheGob registers the responseCache type with the encoding/gob package.

# Constants

# Variables