response

Documentation

Index

• type JSONError
• type JSONResponse
  • func JSON(w http.ResponseWriter) *JSONResponse
  • func (jresp *JSONResponse) Data(data interface{}) *JSONResponse
  • func (jresp *JSONResponse) Error(err error, errResp *JSONError) *JSONResponse
  • func (jresp *JSONResponse) SetHeader(key, value string)
  • func (jresp *JSONResponse) Write() (int, error)
  • func (jresp *JSONResponse) WriteHeader(statusCode int) *JSONResponse
• type JSONRetryResponse
• type Status

Types

type JSONError

type JSONError struct {
	Title   string   `json:"title"`
	Message string   `json:"message"`
	Detail  string   `json:"detail"`
	Errors  []string `json:"errors"`
}

JSONError struct for error field in json response

type JSONResponse

type JSONResponse struct {

	// response part
	ResponseStatus Status             `json:"status"`
	ResponseData   interface{}        `json:"data"`
	ResponseRetry  *JSONRetryResponse `json:"retry,omitempty"`
	ResponseError  *JSONError         `json:"error,omitempty"`
	// contains filtered or unexported fields
}

JSONResponse struct for http json response

func JSON

func JSON(w http.ResponseWriter) *JSONResponse

JSON create a new JSON response

func (*JSONResponse) Data

func (jresp *JSONResponse) Data(data interface{}) *JSONResponse

Data for set data to json response

func (*JSONResponse) Error

func (jresp *JSONResponse) Error(err error, errResp *JSONError) *JSONResponse

Error set error to json response only use error when the type of error is *xerrors.Error

func (*JSONResponse) SetHeader

func (jresp *JSONResponse) SetHeader(key, value string)

SetHeader used to set header in http.ResponseWriter of JSONResponse

func (*JSONResponse) Write

func (jresp *JSONResponse) Write() (int, error)

Write json response

func (*JSONResponse) WriteHeader

func (jresp *JSONResponse) WriteHeader(statusCode int) *JSONResponse

WriteHeader set the header of JSONResponse writer

type JSONRetryResponse

type JSONRetryResponse struct {
	RetryMin int `json:"retry_min"`
	RetryMax int `json:"retry_max"`
}

JSONRetryResponse struct for retry field in json response

type Status

type Status string

Status of json response

const (
	StatusOK            Status = "OK"
	StatusRetry         Status = "RETRY"
	StatusBadRequest    Status = "BAD_REQUEST"
	StatusNotFound      Status = "NOT_FOUND"
	StatusUnauthorized  Status = "UNAUTHORIZED"
	StatusInternalError Status = "INTERNAL_ERROR"
)

list of status for http response