Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

middleware

package

Go to main page

Versions in this module

v1

v1.7.7

Jun 2, 2025

Changes in this version

type BaseConfiguration

+ SurrogateKeyDisabled bool

+ func (c *BaseConfiguration) IsSurrogateDisabled() bool

v1.7.6

Mar 11, 2025

v1.7.5

Nov 6, 2024

v1.7.4

Oct 28, 2024

v1.7.3

Oct 28, 2024

Changes in this version

+ var Upstream50xError = upstream50xError

type CustomWriter

+ func (r *CustomWriter) GetStatusCode() int

v1.7.2

Sep 19, 2024

v1.7.1

Sep 19, 2024

v1.7.0

Sep 11, 2024

v1.6.50

Aug 21, 2024

Changes in this version

+ type BaseConfiguration struct

+ API configurationtypes.API

+ CacheKeys configurationtypes.CacheKeys

+ DefaultCache *configurationtypes.DefaultCache

+ LogLevel string

+ PluginName string

+ SurrogateKeys map[string]configurationtypes.SurrogateKeys

+ URLs map[string]configurationtypes.URL

+ Ykeys map[string]configurationtypes.SurrogateKeys

+ func (c *BaseConfiguration) GetAPI() configurationtypes.API

+ func (c *BaseConfiguration) GetCacheKeys() configurationtypes.CacheKeys

+ func (c *BaseConfiguration) GetDefaultCache() configurationtypes.DefaultCacheInterface

+ func (c *BaseConfiguration) GetLogLevel() string

+ func (c *BaseConfiguration) GetPluginName() string

+ func (c *BaseConfiguration) GetSurrogateKeys() map[string]configurationtypes.SurrogateKeys

+ func (c *BaseConfiguration) GetUrls() map[string]configurationtypes.URL

+ func (c *BaseConfiguration) GetYkeys() map[string]configurationtypes.SurrogateKeys

+ type CustomWriter struct

+ Buf *bytes.Buffer

+ Headers http.Header

+ Req *http.Request

+ Rw http.ResponseWriter

+ func NewCustomWriter(rq *http.Request, rw http.ResponseWriter, b *bytes.Buffer) *CustomWriter

+ func (r *CustomWriter) Header() http.Header

+ func (r *CustomWriter) Send() (int, error)

+ func (r *CustomWriter) Write(b []byte) (int, error)

+ func (r *CustomWriter) WriteHeader(code int)

+ type SouinBaseHandler struct

+ Configuration configurationtypes.AbstractConfigurationInterface

+ DefaultMatchedUrl configurationtypes.URL

+ ExcludeRegex *regexp.Regexp

+ InternalEndpointHandlers *api.MapHandler

+ RegexpUrls regexp.Regexp

+ Storers []types.Storer

+ SurrogateKeyStorer providers.SurrogateInterface

+ SurrogateKeys configurationtypes.SurrogateKeys

+ func NewHTTPCacheHandler(c configurationtypes.AbstractConfigurationInterface) *SouinBaseHandler

+ func (s *SouinBaseHandler) HandleInternally(r *http.Request) (bool, http.HandlerFunc)

+ func (s *SouinBaseHandler) Revalidate(validator *rfc.Revalidator, next handlerFunc, customWriter *CustomWriter, ...) error

+ func (s *SouinBaseHandler) ServeHTTP(rw http.ResponseWriter, rq *http.Request, next handlerFunc) error

+ func (s *SouinBaseHandler) Store(customWriter *CustomWriter, rq *http.Request, ...) error

+ func (s *SouinBaseHandler) Upstream(customWriter *CustomWriter, rq *http.Request, next handlerFunc, ...) error

+ type SouinWriterInterface interface

+ Send func() (int, error)