serializer

Documentation

Index

• type HTTPError
  • func NewHTTPError(statusCode int, msg ...string) HTTPError
  • func NewMySQLError(statusCode int, mysqlCode uint16, msg ...string) HTTPError
• type Response
  • func NewEmptyResponse() *Response
  • func NewQueryResponse(rows []map[string]interface{}, columnNames, columnTypes []string) *Response
  • func NewVersionResponse(version string) *Response

Types

type HTTPError

type HTTPError interface {
	error
	StatusCode() int
}

HTTPError defines an Error message as it will be written in the http.Response

func NewHTTPError

func NewHTTPError(statusCode int, msg ...string) HTTPError

NewHTTPError returns an Error

func NewMySQLError

func NewMySQLError(statusCode int, mysqlCode uint16, msg ...string) HTTPError

NewHTTPError returns an Error with the MySQL error code

type Response

type Response struct {
	Status int         `json:"status"`
	Data   interface{} `json:"data,omitempty"`
	Meta   interface{} `json:"meta,omitempty"`
	Errors []HTTPError `json:"errors,omitempty"`
}

Response encapsulate the content of an http.Response

func NewEmptyResponse

func NewEmptyResponse() *Response

NewEmptyResponse returns an empty Response

func NewQueryResponse

func NewQueryResponse(rows []map[string]interface{}, columnNames, columnTypes []string) *Response

NewQueryResponse returns a Response with table headers and row contents

func NewVersionResponse

func NewVersionResponse(version string) *Response

NewVersionResponse returns a Response with current version of the server