goyave

README

Goyave middleware: Souin

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

Features

• RFC 7234 compliant HTTP Cache.
• Sets the Cache-Status HTTP 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"

	cache "github.com/darkweak/souin/plugins/goyave"
	"goyave.dev/goyave/v4"
)

func main() {
	// ...
	goyave.Start(func(r *goyave.Router) {
		r.GlobalMiddleware(cache.NewHTTPCache(cache.DevDefaultConfiguration).Handle)
		// ...
	})
}

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 Goyave Configuration structure into the NewHTTPCache 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 goyave middleware

Documentation

Index

• Variables
• type SouinGoyaveMiddleware
  • func NewHTTPCache(c middleware.BaseConfiguration) *SouinGoyaveMiddleware
  • func (s *SouinGoyaveMiddleware) Handle(next goyave.Handler) goyave.Handler

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: "info",
	}
)

Types

type SouinGoyaveMiddleware

type SouinGoyaveMiddleware struct {
	*middleware.SouinBaseHandler
}

SouinGoyaveMiddleware declaration.

func NewHTTPCache

func NewHTTPCache(c middleware.BaseConfiguration) *SouinGoyaveMiddleware

func (*SouinGoyaveMiddleware) Handle

func (s *SouinGoyaveMiddleware) Handle(next goyave.Handler) goyave.Handler