web

Documentation

Index

• Constants
• func IsShutdown(err error) bool
• func NewRequestError(err error, status int) error
• func NewShutdownError(message string) error
• func Redirect302(ctx *fasthttp.RequestCtx, redirectUrl string) error
• func Respond(ctx *fasthttp.RequestCtx, data interface{}, statusCode int) error
• func RespondError(ctx *fasthttp.RequestCtx, statusCode int, statusHeader *string) error
• func ShadowAPIChecks(ctx *fasthttp.RequestCtx, logger *logrus.Logger, shadowApi *config.ShadowAPI)
• type App
  • func NewApp(shutdown chan os.Signal, cfg *config.APIFWConfiguration, logger *logrus.Logger, ...) *App
  • func (a *App) Handle(method string, path string, handler Handler, mw ...Middleware)
  • func (a *App) SetDefaultBehavior(handler Handler, mw ...Middleware)
  • func (a *App) SignalShutdown()
• type Error
  • func (err *Error) Error() string
• type ErrorResponse
• type FieldError
• type Handler
• type Middleware

Constants

const (
	ValidationStatus = "APIFW-Validation-Status"

	ValidationDisable = "DISABLE"
	ValidationBlock   = "BLOCK"
	ValidationLog     = "LOG_ONLY"
)

Functions

func IsShutdown

func IsShutdown(err error) bool

IsShutdown checks to see if the shutdown error is contained in the specified error value.

func NewRequestError

func NewRequestError(err error, status int) error

NewRequestError wraps a provided error with an HTTP status code. This function should be used when handlers encounter expected errors.

func NewShutdownError

func NewShutdownError(message string) error

NewShutdownError returns an error that causes the framework to signal a graceful shutdown.

func Redirect302

func Redirect302(ctx *fasthttp.RequestCtx, redirectUrl string) error

Redirect302 redirects client with code 302

func Respond

func Respond(ctx *fasthttp.RequestCtx, data interface{}, statusCode int) error

Respond converts a Go value to JSON and sends it to the client.

func RespondError

func RespondError(ctx *fasthttp.RequestCtx, statusCode int, statusHeader *string) error

RespondError sends an error reponse back to the client.

func ShadowAPIChecks

func ShadowAPIChecks(ctx *fasthttp.RequestCtx, logger *logrus.Logger, shadowApi *config.ShadowAPI)

Types

type App

type App struct {
	Router *router.Router
	Log    *logrus.Logger
	// contains filtered or unexported fields
}

App is the entrypoint into our application and what configures our context object for each of our http handlers. Feel free to add any configuration data/logic on this App struct

func NewApp

func NewApp(shutdown chan os.Signal, cfg *config.APIFWConfiguration, logger *logrus.Logger, mw ...Middleware) *App

NewApp creates an App value that handle a set of routes for the application.

func (*App) Handle

func (a *App) Handle(method string, path string, handler Handler, mw ...Middleware)

Handle is our mechanism for mounting Handlers for a given HTTP verb and path pair, this makes for really easy, convenient routing.

func (*App) SetDefaultBehavior

func (a *App) SetDefaultBehavior(handler Handler, mw ...Middleware)

func (*App) SignalShutdown

func (a *App) SignalShutdown()

SignalShutdown is used to gracefully shutdown the app when an integrity issue is identified.

type Error

type Error struct {
	Err    error
	Status int
	Fields []FieldError
}

Error is used to pass an error during the request through the application with web specific context.

func (*Error) Error

func (err *Error) Error() string

Error implements the error interface. It uses the default message of the wrapped error. This is what will be shown in the services' logs.

type ErrorResponse

type ErrorResponse struct {
	Error  string       `json:"error"`
	Fields []FieldError `json:"fields,omitempty"`
}

ErrorResponse is the form used for API responses from failures in the API.

type FieldError

type FieldError struct {
	Field string `json:"field"`
	Error string `json:"error"`
}

FieldError is used to indicate an error with a specific request field.

type Handler

type Handler func(ctx *fasthttp.RequestCtx) error

A Handler is a type that handles an http request within our own little mini framework.

type Middleware

type Middleware func(Handler) Handler

Middleware is a function designed to run some code before and/or after another Handler. It is designed to remove boilerplate or other concerns not direct to any given Handler.