shared

Documentation

Index

• Constants
• func MarshalError(err *WiretapError) []byte
• func Pluralize(n int, singular string, plural string) string
• type CompiledPath
• type CompiledPathRewrite
• type WiretapConfiguration
  • func (wtc *WiretapConfiguration) CompilePaths()
• type WiretapError
  • func GenerateError(title string, status int, detail string, instance string) *WiretapError
• type WiretapHeaderConfig
• type WiretapPathConfig
  • func (wpc *WiretapPathConfig) Compile(key string) *CompiledPath

Constants

const ConfigKey = "config"

const IndexFile = "index.html"

const UIAssetsLocation = "ui/dist/assets"

const UILocation = "ui/dist"

const WiretapPortPlaceholder = "%WIRETAP_PORT%"

Functions

func MarshalError

func MarshalError(err *WiretapError) []byte

func Pluralize

func Pluralize(n int, singular string, plural string) string

Types

type CompiledPath

type CompiledPath struct {
	PathConfig          *WiretapPathConfig
	CompiledKey         glob.Glob
	CompiledTarget      glob.Glob
	CompiledPathRewrite map[string]*regexp.Regexp
}

type CompiledPathRewrite

type CompiledPathRewrite struct {
	PathConfig     *WiretapPathConfig
	Key            string
	CompiledKey    glob.Glob
	CompiledTarget glob.Glob
}

type WiretapConfiguration

type WiretapConfiguration struct {
	Contract            string                        `json:"-" yaml:"-"`
	RedirectHost        string                        `json:"redirectHost,omitempty" yaml:"redirectHost,omitempty"`
	RedirectPort        string                        `json:"redirectPort,omitempty" yaml:"redirectPort,omitempty"`
	RedirectBasePath    string                        `json:"redirectBasePath,omitempty" yaml:"redirectBasePath,omitempty"`
	RedirectProtocol    string                        `json:"redirectProtocol,omitempty" yaml:"redirectProtocol,omitempty"`
	RedirectURL         string                        `json:"redirectURL,omitempty" yaml:"redirectURL,omitempty"`
	Port                string                        `json:"port,omitempty" yaml:"port,omitempty"`
	MonitorPort         string                        `json:"monitorPort,omitempty" yaml:"monitorPort,omitempty"`
	WebSocketPort       string                        `json:"webSocketPort,omitempty" yaml:"webSocketPort,omitempty"`
	GlobalAPIDelay      int                           `json:"globalAPIDelay,omitempty" yaml:"globalAPIDelay,omitempty"`
	StaticDir           string                        `json:"staticDir,omitempty" yaml:"staticDir,omitempty"`
	StaticIndex         string                        `json:"staticIndex,omitempty" yaml:"staticIndex,omitempty"`
	PathConfigurations  map[string]*WiretapPathConfig `json:"paths,omitempty" yaml:"paths,omitempty"`
	Headers             *WiretapHeaderConfig          `json:"headers,omitempty" yaml:"headers,omitempty"`
	StaticPaths         []string                      `json:"staticPaths,omitempty" yaml:"staticPaths,omitempty"`
	StaticPathsCompiled []glob.Glob                   `json:"-" yaml:"-"`
	CompiledPaths       map[string]*CompiledPath      `json:"-"`
	FS                  embed.FS                      `json:"-"`
}

func (*WiretapConfiguration) CompilePaths

func (wtc *WiretapConfiguration) CompilePaths()

type WiretapError

type WiretapError struct {
	Type     string `json:"type,omitempty"`   // URI reference to the type of problem
	Title    string `json:"title"`            // A short description of the issue
	Status   int    `json:"status,omitempty"` // HTTP status code.
	Detail   string `json:"detail"`           // explanation of the issue in detail.
	Instance string `json:"instance"`         // URI to the specific problem.
}

WiretapError is an rfc7807 compliant error struct

func GenerateError

func GenerateError(title string,
	status int,
	detail string,
	instance string) *WiretapError

type WiretapHeaderConfig

type WiretapHeaderConfig struct {
	DropHeaders []string `json:"drop,omitempty" yaml:"drop,omitempty"`
}

type WiretapPathConfig

type WiretapPathConfig struct {
	Target       string            `json:"target,omitempty" yaml:"target,omitempty"`
	PathRewrite  map[string]string `json:"pathRewrite,omitempty" yaml:"pathRewrite,omitempty"`
	CompiledPath *CompiledPath     `json:"-"`
	Secure       bool              `json:"secure,omitempty" yaml:"secure"`
}

func (*WiretapPathConfig) Compile

func (wpc *WiretapPathConfig) Compile(key string) *CompiledPath