response

Documentation

Index

• Constants
• Variables
• type BasicResponse
  • func (b *BasicResponse) WriteResponse(w http.ResponseWriter)
• type CSVBody
• type CSVResponse
  • func NewCSVResponse() *CSVResponse
  • func (r *CSVResponse) SetData(data []byte) *CSVResponse
  • func (r *CSVResponse) SetName(name string) *CSVResponse
  • func (r *CSVResponse) WriteResponse(w http.ResponseWriter)
• type Error
  • func NewError(message string, code int) *Error
  • func (re *Error) Error() string
• type HTTPResponse
• type JSONBody
• type JSONResponse
  • func NewJSONResponse() *JSONResponse
  • func (r *JSONResponse) SetData(data interface{}) *JSONResponse
  • func (r *JSONResponse) SetError(err error) *JSONResponse
  • func (r *JSONResponse) SetMessage(message string) *JSONResponse
  • func (r *JSONResponse) WriteResponse(w http.ResponseWriter)

Constants

const CSVContentType = "text/csv"

const JSONContentType = "application/json"

Variables

var (
	ErrorInternalServer    = NewError("Internal Server Error", http.StatusInternalServerError)
	ErrorForbiddenResource = NewError("Forbidden Resource", http.StatusForbidden)
	ErrorBadRequest        = NewError("Bad Request", http.StatusBadRequest)
)

Types

type BasicResponse

type BasicResponse struct {
	Body        []byte
	StatusCode  int
	ContentType string
}

func (*BasicResponse) WriteResponse

func (b *BasicResponse) WriteResponse(w http.ResponseWriter)

type CSVBody

type CSVBody struct {
	*Error
	Name string
}

type CSVResponse

type CSVResponse struct {
	BasicResponse
	CSVBody CSVBody
	Error   error
}

func NewCSVResponse

func NewCSVResponse() *CSVResponse

func (*CSVResponse) SetData

func (r *CSVResponse) SetData(data []byte) *CSVResponse

func (*CSVResponse) SetName

func (r *CSVResponse) SetName(name string) *CSVResponse

func (*CSVResponse) WriteResponse

func (r *CSVResponse) WriteResponse(w http.ResponseWriter)

type Error

type Error struct {
	ErrorMessage string `json:"error,omitempty"`
	ErrorCode    int    `json:"error_code,omitempty"`
}

func NewError

func NewError(message string, code int) *Error

func (*Error) Error

func (re *Error) Error() string

type HTTPResponse

type HTTPResponse interface {
	WriteResponse(w http.ResponseWriter)
}

type JSONBody

type JSONBody struct {
	*Error
	Message string      `json:"message,omitempty"`
	Data    interface{} `json:"data,omitempty"`
}

type JSONResponse

type JSONResponse struct {
	BasicResponse
	JSONBody JSONBody
	Error    error
}

func NewJSONResponse

func NewJSONResponse() *JSONResponse

func (*JSONResponse) SetData

func (r *JSONResponse) SetData(data interface{}) *JSONResponse

func (*JSONResponse) SetError

func (r *JSONResponse) SetError(err error) *JSONResponse

func (*JSONResponse) SetMessage

func (r *JSONResponse) SetMessage(message string) *JSONResponse

func (*JSONResponse) WriteResponse

func (r *JSONResponse) WriteResponse(w http.ResponseWriter)