Documentation
¶
Index ¶
- Variables
- type DefaultHandler
- func (d *DefaultHandler) Decode(w http.ResponseWriter, r *http.Request, dest interface{}) (err error)
- func (d *DefaultHandler) DecodeAndValidate(w http.ResponseWriter, r *http.Request, body interface{}, ...) bool
- func (d *DefaultHandler) HandleError(w http.ResponseWriter, err error, httpStatus int)
- func (d *DefaultHandler) HandleErrorProneResponse(w http.ResponseWriter, successResponse *gonethttpresponse.Response, ...)
- func (d *DefaultHandler) HandleResponse(w http.ResponseWriter, response *gonethttpresponse.Response)
- func (d *DefaultHandler) Validate(w http.ResponseWriter, body interface{}, ...) bool
- type Handler
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrNilHandler = errors.New("response handler cannot be nil")
)
Functions ¶
This section is empty.
Types ¶
type DefaultHandler ¶
type DefaultHandler struct {
// contains filtered or unexported fields
}
DefaultHandler struct
func NewDefaultHandler ¶
func NewDefaultHandler( mode *goflagsmode.Flag, jsonEncoder gonethttpjson.Encoder, jsonDecoder gonethttpjson.Decoder, ) (*DefaultHandler, error)
NewDefaultHandler creates a new default request handler
func (*DefaultHandler) Decode ¶ added in v0.5.27
func (d *DefaultHandler) Decode( w http.ResponseWriter, r *http.Request, dest interface{}, ) (err error)
Decode decodes the request body into the destination
func (*DefaultHandler) DecodeAndValidate ¶ added in v0.5.27
func (d *DefaultHandler) DecodeAndValidate( w http.ResponseWriter, r *http.Request, body interface{}, validatorFn func(body interface{}) (interface{}, error), ) bool
DecodeAndValidate decodes and validates the request body
func (*DefaultHandler) HandleError ¶ added in v0.5.27
func (d *DefaultHandler) HandleError( w http.ResponseWriter, err error, httpStatus int, )
HandleError handles the error response
func (*DefaultHandler) HandleErrorProneResponse ¶
func (d *DefaultHandler) HandleErrorProneResponse( w http.ResponseWriter, successResponse *gonethttpresponse.Response, errorResponse *gonethttpresponse.Response, )
HandleErrorProneResponse handles the response that may contain an error
func (*DefaultHandler) HandleResponse ¶ added in v0.4.4
func (d *DefaultHandler) HandleResponse( w http.ResponseWriter, response *gonethttpresponse.Response, )
HandleResponse handles the response
func (*DefaultHandler) Validate ¶ added in v0.5.27
func (d *DefaultHandler) Validate( w http.ResponseWriter, body interface{}, validatorFn func(body interface{}) (interface{}, error), ) bool
Validate validates the request body
type Handler ¶
type Handler interface {
Decode(
w http.ResponseWriter,
r *http.Request,
dest interface{},
) error
Validate(
w http.ResponseWriter,
body interface{},
validatorFn func(body interface{}) (interface{}, error),
) bool
DecodeAndValidate(
w http.ResponseWriter,
r *http.Request,
dest interface{},
validatorFn func(body interface{}) (interface{}, error),
) bool
HandleError(
w http.ResponseWriter,
err error,
httpStatus int,
)
HandleResponse(
w http.ResponseWriter,
response *gonethttpresponse.Response,
)
HandleErrorProneResponse(
w http.ResponseWriter,
successResponse *gonethttpresponse.Response,
errorResponse *gonethttpresponse.Response,
)
}
Handler interface for handling the responses
Source Files
Click to show internal directories.
Click to hide internal directories.