response

Documentation

Overview

Package response implements reflection-based net/http response encoder.

Index

• func EncoderMiddleware(handler fchi.Handler) fchi.Handler
• func ValidatorMiddleware(factory rest.ResponseValidatorFactory) func(fchi.Handler) fchi.Handler
• type Encoder
  • func (h *Encoder) MakeOutput(rc *fasthttp.RequestCtx, ht rest.HandlerTrait) interface{}
  • func (h *Encoder) SetupOutput(output interface{}, ht *rest.HandlerTrait)
  • func (h *Encoder) WriteErrResponse(rc *fasthttp.RequestCtx, statusCode int, response interface{})
  • func (h *Encoder) WriteSuccessfulResponse(rc *fasthttp.RequestCtx, output interface{}, ht rest.HandlerTrait)

Functions

func EncoderMiddleware

func EncoderMiddleware(handler fchi.Handler) fchi.Handler

EncoderMiddleware instruments qualifying fchi.Handler with Encoder.

func ValidatorMiddleware

func ValidatorMiddleware(factory rest.ResponseValidatorFactory) func(fchi.Handler) fchi.Handler

ValidatorMiddleware sets up response validator in suitable handlers.

Types

type Encoder

type Encoder struct {
	JSONWriter func(v interface{})
	// contains filtered or unexported fields
}

Encoder prepares and writes http response.

func (*Encoder) MakeOutput

func (h *Encoder) MakeOutput(rc *fasthttp.RequestCtx, ht rest.HandlerTrait) interface{}

MakeOutput instantiates a value for use case output port.

func (*Encoder) SetupOutput

func (h *Encoder) SetupOutput(output interface{}, ht *rest.HandlerTrait)

SetupOutput configures encoder with and instance of use case output.

func (*Encoder) WriteErrResponse

func (h *Encoder) WriteErrResponse(rc *fasthttp.RequestCtx, statusCode int, response interface{})

WriteErrResponse encodes and writes error to response.

func (*Encoder) WriteSuccessfulResponse

func (h *Encoder) WriteSuccessfulResponse(
	rc *fasthttp.RequestCtx,
	output interface{},
	ht rest.HandlerTrait,
)

WriteSuccessfulResponse encodes and writes successful output of use case interactor to http response.