httputils

Documentation

Index

• type ClientErrorResponse
• type Sender
  • func (s *Sender) JSON(w http.ResponseWriter, statusCode int, v interface{}) error
• type ServerErrorResponse
• type SuccessfulResponse

Types

type ClientErrorResponse

type ClientErrorResponse struct {
	StatusCode int           `json:"statusCode"`
	Error      localErrs.Err `json:"error"`
	Timestamp  time.Time     `json:"timestamp"`
}

ClientErrorResponse standardizes responses with 400-499 status code

type Sender

type Sender struct {
	Render *render.Render
}

func (*Sender) JSON

func (s *Sender) JSON(w http.ResponseWriter, statusCode int, v interface{}) error

JSON formats the v in a json format and sends it to the client with w. If the statusCode is specific for a error, then v is assumed to be a string, an error or an custom errors.Err struct

type ServerErrorResponse

type ServerErrorResponse struct {
	StatusCode int           `json:"statusCode"`
	Error      localErrs.Err `json:"error"`
	Timestamp  time.Time     `json:"timestamp"`
}

ServerErrorResponse standardizes responses with 500-599 status code

type SuccessfulResponse

type SuccessfulResponse struct {
	Data      interface{} `json:"data"`
	Timestamp time.Time   `json:"timestamp"`
}

SuccessfulResponse standardizes responses with 200-299 status code