sizelimit

README

krakend-sizelimit

The sizelimit middleware can be used to limit the request size of incoming requests.

Installation

To install sizelimit from GitHub:

go get -u github.com/kivra/krakend-sizelimit@<commit hash>

Then add sizelimit to the KrakenD handler_factory chain:

handlerFactory = sizelimit.HandlerFactory(handlerFactory)

Usage

Add sizelimit to the endpoint's extra_config and define the maximum request body size. If no unit is specified, max_size is assumed to have unit bytes. Other units can be specified explictly: B (bytes, same as no unit), kB, MB, GB, TB.

"endpoints": [
  {
    "endpoint": "/test",
    "extra_config": {
      "kivra/sizelimit": {
        "max_size": "10MB"
      }
    },
    "backend": [ "..." ]
  }
]

Documentation

Index

• Constants
• func ExceedsSizeLimit(c *gin.Context, limit int64) bool
• func HandlerFactory(next krakendgin.HandlerFactory) krakendgin.HandlerFactory
• func LimiterFactory(limit int64, handlerFunc gin.HandlerFunc) gin.HandlerFunc
• func ParseMaxSize(cfg *Config) int64
• type Config
• type ConfigInternal
  • func ConfigGetter(e config.ExtraConfig) (*ConfigInternal, bool)

Constants

const Namespace = "kivra/sizelimit"

Functions

func ExceedsSizeLimit

func ExceedsSizeLimit(c *gin.Context, limit int64) bool

func HandlerFactory

func HandlerFactory(next krakendgin.HandlerFactory) krakendgin.HandlerFactory

func LimiterFactory

func LimiterFactory(limit int64, handlerFunc gin.HandlerFunc) gin.HandlerFunc

func ParseMaxSize

func ParseMaxSize(cfg *Config) int64

Types

type Config

type Config struct {
	MaxSize string `json:"max_size"`
}

type ConfigInternal

type ConfigInternal struct {
	MaxSize int64 `json:"max_size"`
}

func ConfigGetter

func ConfigGetter(e config.ExtraConfig) (*ConfigInternal, bool)