web

Documentation

Index

• Variables
• func RequestMW(next http.Handler) http.Handler
• func Respond(w http.ResponseWriter, r *http.Request, code int, data interface{}, ...)
• func RespondError(w http.ResponseWriter, r *http.Request, code int, err error)
• type Response
• type ResponseError
  • func (a ResponseError) Error() string

Variables

var ErrInternalServer = errors.New("internal server error")

ErrInternalServer is a generic internal server error.

Functions

func RequestMW

func RequestMW(next http.Handler) http.Handler

RequestMW is a middleware that creates a request id for each request and sets it on the header field X-Request-Id. Also logs the start and end of each request.

func Respond

func Respond(w http.ResponseWriter, r *http.Request, code int, data interface{}, errs ...error)

Respond sends a response with a status code.

func RespondError

func RespondError(w http.ResponseWriter, r *http.Request, code int, err error)

RespondError sends an error response with a status code. The error is automatically logged for you. If the error implements StatusCoder, the provided status code will be used.

Types

type Response

type Response struct {
	Results interface{}     `json:"results,omitempty"`
	Errors  []ResponseError `json:"errors,omitempty"`
}

Response is the format used for all the responses.

type ResponseError

type ResponseError struct {
	Message string `json:"message"`
}

ResponseError is the format used for response errors.

func (ResponseError) Error

func (a ResponseError) Error() string

Error implements the error interface