https://github.com/gin-contrib/cache

Gin middleware/handler to enable Cache
https://github.com/gin-contrib/cache

Last synced: about 2 months ago
JSON representation

Gin middleware/handler to enable Cache

• Host: GitHub
• URL: https://github.com/gin-contrib/cache
• Owner: gin-contrib
• License: mit
• Created: 2016-11-14T16:25:50.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-10T00:47:07.000Z (about 1 year ago)
• Last Synced: 2024-05-10T01:41:16.914Z (about 1 year ago)
• Language: Go
• Homepage: https://gin-gonic.github.io/gin
• Size: 192 KB
• Stars: 351
• Watchers: 13
• Forks: 94
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-gin - gin-contrib/cache

README

        
# Cache gin's middleware

[![Build Status](https://github.com/gin-contrib/cache/actions/workflows/testing.yml/badge.svg)](https://github.com/gin-contrib/cache/actions/workflows/testing.yml)

[![codecov](https://codecov.io/gh/gin-contrib/cache/branch/master/graph/badge.svg)](https://codecov.io/gh/gin-contrib/cache)

[![Go Report Card](https://goreportcard.com/badge/github.com/gin-contrib/cache)](https://goreportcard.com/report/github.com/gin-contrib/cache)

[![GoDoc](https://godoc.org/github.com/gin-contrib/cache?status.svg)](https://godoc.org/github.com/gin-contrib/cache)

Gin middleware/handler to enable Cache.

## Usage

### Start using it

Download and install it:

```sh

go get github.com/gin-contrib/cache

```

Import it in your code:

```go

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

```

### Canonical example:

See the [example](example/example.go)

```go

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")

}

```