forked from darkweak/souin
README.md

Gin middleware: Souin #

This is a distributed HTTP cache module for Gin based on Souin cache.

Features #

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