apigateway

Documentation

Overview

Package apigateway provides a standard serialization format to wrap API Gateway responses that translate into specific end-user errors.

Index

• type Error
  • func NewErrorResponse(statusCode int, messages ...string) *Error
  • func (apigError *Error) Error() string

Types

type Error

type Error struct {
	Code    int                    `json:"code"`
	Err     string                 `json:"err"`
	Message string                 `json:"message"`
	Context map[string]interface{} `json:"context,omitempty"`
}

Error represents an error to return in response to an API Gateway request

func NewErrorResponse

func NewErrorResponse(statusCode int, messages ...string) *Error

NewErrorResponse returns a response that satisfies the regular expression used to determine integration mappings via the API Gateway

func (*Error) Error

func (apigError *Error) Error() string

Error returns the JSONified version of this error which will trigger the appropriate integration mapping.