response

Documentation

Index

• type APIResponse
  • func NewAPIResponse(name, description string) *APIResponse
  • func (ar *APIResponse) SendResponseTO(w http.ResponseWriter)
• type ErrorResponse
  • func (er *ErrorResponse) WriteErrorTo(w http.ResponseWriter)
• type ServiceResponse
  • func NewError(err error) *ServiceResponse
  • func NewErrorCode(code int, err error) *ServiceResponse
  • func NewSuccess(content string) *ServiceResponse
  • func (sr *ServiceResponse) ToErrorResponse() *ErrorResponse

Types

type APIResponse

type APIResponse struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

APIResponse repsent the API response to return from Pokemon endpoints. Its fields are intended for JSON marshalling and unmarshalling purpose.

func NewAPIResponse

func NewAPIResponse(name, description string) *APIResponse

func (*APIResponse) SendResponseTO

func (ar *APIResponse) SendResponseTO(w http.ResponseWriter)

SendResponseTO sends the APIResponse contents as a HTTP response in the JSON form with the appropriate HTTP status code.

type ErrorResponse

type ErrorResponse struct {
	Error string `json:"error"`
	Code  int    `json:"code"`
}

ErrorResponse repsent the API error to return from Pokemon endpoints. Its fields are intended for JSON marshalling and unmarshalling purpose.

func (*ErrorResponse) WriteErrorTo

func (er *ErrorResponse) WriteErrorTo(w http.ResponseWriter)

ErrorResponse sends the ErrorResponse contents as a HTTP response in the JSON form with the appropriate HTTP status code.

type ServiceResponse

type ServiceResponse struct {
	Content   string
	Error     error
	ErrorCode int
}

ServiceResponse to represent the response from the different services integrations

func NewError

func NewError(err error) *ServiceResponse

NewError creates the ServiceResponse with error value to represent only an error

func NewErrorCode

func NewErrorCode(code int, err error) *ServiceResponse

NewErrorCode creates the ServiceResponse with error value and code to represent only an error message and the error code from service integration responses.

func NewSuccess

func NewSuccess(content string) *ServiceResponse

NewSuccess creates the ServiceResponse to to represnet the response body from service integration response.

func (*ServiceResponse) ToErrorResponse

func (sr *ServiceResponse) ToErrorResponse() *ErrorResponse

ToErrorResponse create the ErrorResponse type to from the error fields of ServiceResponse. The ErrorResponse is used to represent the API error response.