restapi

Documentation

Index

• Constants
• func ExtractLimitAndOffset(qs url.Values) (int, int, error)
• type DataResponse
• type ErrorHandler
  • func (t *ErrorHandler) Write(rw http.ResponseWriter, err error, statusCode int)
• type ErrorResponder
• type RESTAPIHandler
• type Responder
• type ResponseHandler
  • func (t *ResponseHandler) Redirect(rw http.ResponseWriter, r *http.Request, uri string)
  • func (t *ResponseHandler) Write(rw http.ResponseWriter, data interface{}, statusCode int)
  • func (t *ResponseHandler) WriteRaw(rw http.ResponseWriter, data interface{}, statusCode int)
• type ServerResponse

Constants

const BadRequestPrefix string = "Bad Request"

const InternalServerErrorPrefix string = "Internal Server Error"

const NotFoundPrefix string = "404 Not Found"

const NotImplementedPrefix string = "Not Implemented"

const UnprocessablePrefix string = "Unprocessable Entity"

Functions

func ExtractLimitAndOffset

func ExtractLimitAndOffset(qs url.Values) (int, int, error)

ExtractLimitAndOffset is a convience method to extract pagination and limit values passed to a handler that supports pages.

Types

type DataResponse

type DataResponse struct {
	Code int         `json:"code"`
	Data interface{} `json:"data"`
}

type ErrorHandler

type ErrorHandler struct{}

func (*ErrorHandler) Write

func (t *ErrorHandler) Write(rw http.ResponseWriter, err error, statusCode int)

type ErrorResponder

type ErrorResponder interface {
	Write(rw http.ResponseWriter, err error, statusCode int)
}

type RESTAPIHandler

type RESTAPIHandler interface {
	GetHttpHandler(mountPath string) http.Handler
}

type Responder

type Responder interface {
	Write(rw http.ResponseWriter, data interface{}, statusCode int)
	WriteRaw(rw http.ResponseWriter, data interface{}, statusCode int)
	Redirect(rw http.ResponseWriter, r *http.Request, uri string)
}

type ResponseHandler

type ResponseHandler struct{}

func (*ResponseHandler) Redirect

func (t *ResponseHandler) Redirect(rw http.ResponseWriter, r *http.Request, uri string)

func (*ResponseHandler) Write

func (t *ResponseHandler) Write(rw http.ResponseWriter, data interface{}, statusCode int)

func (*ResponseHandler) WriteRaw

func (t *ResponseHandler) WriteRaw(rw http.ResponseWriter, data interface{}, statusCode int)

type ServerResponse

type ServerResponse struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}