README
¶
Gin middleware: Souin
This is a distributed HTTP cache module for Gin based on Souin cache.
Features
- RFC 7234 compliant HTTP Cache.
- Sets the
Cache-StatusHTTP Response Header - REST API to purge the cache and list stored resources.
- Builtin support for distributed cache.
- Tag-based invalidation.
Example
There is the example about the Souin initialization.
import (
"net/http"
souin_gin "github.com/darkweak/souin/plugins/gin"
"github.com/gin-gonic/gin"
)
func main(){
// ...
s := souin_gin.New(souin_gin.DevDefaultConfiguration)
e.Use(s.Process)
// ...
}
With that your application will be able to cache the responses if possible and returns at least the Cache-Status HTTP header with the different directives mentionned in the RFC specification.
You have to pass a Gin Configuration structure into the New method (you can use the DefaultConfiguration variable to have a built-in production ready configuration).
See the full detailled configuration names here.
Other resources
You can find an example for a docker-compose stack inside the examples folder.
See the Souin configuration for the full configuration, and its associated development gin middleware
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( DefaultConfiguration = middleware.BaseConfiguration{ DefaultCache: &configurationtypes.DefaultCache{ TTL: configurationtypes.Duration{ Duration: 10 * time.Second, }, }, LogLevel: "info", } DevDefaultConfiguration = middleware.BaseConfiguration{ API: configurationtypes.API{ BasePath: "/souin-api", Prometheus: configurationtypes.APIEndpoint{ Enable: true, }, Souin: configurationtypes.APIEndpoint{ Enable: true, }, }, DefaultCache: &configurationtypes.DefaultCache{ Regex: configurationtypes.Regex{ Exclude: "/excluded", }, TTL: configurationtypes.Duration{ Duration: 5 * time.Second, }, }, LogLevel: "debug", } )
Functions ¶
This section is empty.
Types ¶
type SouinGinMiddleware ¶
type SouinGinMiddleware struct {
*middleware.SouinBaseHandler
}
SouinGinMiddleware declaration.
func New ¶
func New(c middleware.BaseConfiguration) *SouinGinMiddleware
func (*SouinGinMiddleware) Process ¶
func (s *SouinGinMiddleware) Process() gin.HandlerFunc
Source Files
Directories