client

type BasicResponse ¶

type BasicResponse struct {
	// contains filtered or unexported fields
}

BasicResponse

When embedded into a Response object, this wil provide basic functionality

func (b *BasicResponse) NewCode(code int)

func (b BasicResponse) StatusCode() int

type CodedResponse ¶

type CodedResponse interface {
	NewCode(code int)
}

CodedResponse An object implementing this can track the response code from server / client. Complements kitDefaults.StatusCoder

type Decorator ¶

type Decorator interface {
	UsingDecorator() func(handler http.Handler) http.Handler
}

Decorator

Executes per request, before the request. Use to apply special CORS rules for a single request. The returned function will be passed the http.Handler associated with the request.

type ErredResponse ¶

type ErredResponse interface {
	NewError(code int, format string, vars ...interface{})
}

ErredResponse An object implementing this can track the error from the server / client. Complements error interface

type ErrorResponse ¶

type ErrorResponse struct {
	// contains filtered or unexported fields
}

ErrorResponse

When embedded into a Response object, this wil provide error handling functionality

func (b ErrorResponse) Error() string

func (b ErrorResponse) Failed() error

func (b *ErrorResponse) NewCode(code int)

func (b *ErrorResponse) NewError(code int, format string, vars ...interface{})

func (b ErrorResponse) StatusCode() int

type ExpandedLogging ¶

type ExpandedLogging struct {
	// contains filtered or unexported fields
}

ExpandedLogging

Added to a response, should enable additional request-scoped log values

func (l *ExpandedLogging) GetAll() map[string]interface{}

func (l *ExpandedLogging) Log(values ...interface{})

type ExtendedLog ¶

type ExtendedLog interface {
	GetAll() map[string]interface{}
}

type HttpRequest ¶

type HttpRequest interface {
	Info() HttpRouteInfo
}

HttpRequest

Indicates essential fields that provide the ability to tag and categorize requests for logging, metrics and other functionality.

type HttpRouteInfo ¶

type HttpRouteInfo struct {
	// Name
	//
	// The name of the request that is sent to the logging middleware. This MUST be unique
	// among all other services that are defined.
	Name string
	// Method
	//
	// HTTP request Method
	Method Method
	// Path
	//  eg. "/path/one" or "v1/path/two"
	// The relative path to the custom root path provided.
	Path string
	// Description
	//
	// A helpful text that describes the service. This will appear in logs.
	Description string
}

type JSONBody ¶

type JSONBody struct{}

JSONBody

When embedded into a request, flags the request as a JSON body to allow for automatic decoding.

type JsonBodyForm ¶

type JsonBodyForm interface {
	// contains filtered or unexported methods
}

type Method ¶

type Method string

const (
	GET     Method = "GET"
	PUT     Method = "PUT"
	DELETE  Method = "DELETE"
	POST    Method = "POST"
	PATCH   Method = "PATCH"
	HEAD    Method = "HEAD"
	OPTIONS Method = "OPTIONS"
)

type OpenAPIExtended ¶

type OpenAPIExtended interface {
	OpenAPIExtensions() map[string]interface{}
}

OpenAPIExtended

Provides the ability to attach openAPI extensions to a request object. These extensions will be parsed by the openapi spec generator and added to the operation.

type OpenAPISecure ¶

type OpenAPISecure interface {
	OpenAPISecurity() []map[string][]string
}

OpenAPISecure

Provides the ability to attach security extensions to a request object. These extensions will be parsed by the openapi spec generator and added to the operation.

type SkipClientValidation ¶

type SkipClientValidation interface {
	SkipClientValidation()
}

type UsingSkipClientValidation ¶ added in v1.2.2

type UsingSkipClientValidation struct{}

func (u UsingSkipClientValidation) SkipClientValidation()

type Validator ¶

type Validator interface {
	// Validate
	//
	// This method, when implemented, will perform one or more validations of the state of the
	// request after being received from the client. If the state is not accepted, a non-nil result
	// is returned for the accompanying error.
	Validate() error
}

Validator

Indicates that the request will have an accompanying validation.