goutils

README

goutils

Go utils.

Documentation

Index

• func NotFoundHandler() http.Handler
• func TokenFromHeader(r *http.Request) string
• func WriteBadRequest(w http.ResponseWriter, details interface{})
• func WriteCreated(w http.ResponseWriter, data, meta interface{})
• func WriteInternalError(w http.ResponseWriter, details interface{})
• func WriteNoContent(w http.ResponseWriter)
• func WriteNotFound(w http.ResponseWriter, details interface{})
• func WriteOK(w http.ResponseWriter, data, meta interface{})
• func WriteResponse(w http.ResponseWriter, code int, body interface{})
• func WriteUnauthorized(w http.ResponseWriter, details interface{})
• func WriteValidationError(w http.ResponseWriter, err error)
• type DataResponse
  • func NewDataResponse(data, meta interface{}) *DataResponse
• type ErrorResponse
  • func NewErrorResponse(code string, details interface{}) *ErrorResponse
• type ErrorResponseError
• type SPAHandler
  • func NewSPAHandler(fsys fs.FS, dirPath string, indexPath string) (*SPAHandler, error)
  • func (h *SPAHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ValidationError
  • func NewValidationError(errorMap map[string]string) *ValidationError
  • func (v *ValidationError) Error() string

Functions

func NotFoundHandler

func NotFoundHandler() http.Handler

NotFoundHandler func

func TokenFromHeader

func TokenFromHeader(r *http.Request) string

TokenFromHeader func

func WriteBadRequest

func WriteBadRequest(w http.ResponseWriter, details interface{})

WriteBadRequest writes 400 response

func WriteCreated

func WriteCreated(w http.ResponseWriter, data, meta interface{})

WriteCreated writes 201 response

func WriteInternalError

func WriteInternalError(w http.ResponseWriter, details interface{})

WriteInternalError writes 500 response

func WriteNoContent

func WriteNoContent(w http.ResponseWriter)

WriteNoContent writes 204 response

func WriteNotFound

func WriteNotFound(w http.ResponseWriter, details interface{})

WriteNotFound writes 404 response

func WriteOK

func WriteOK(w http.ResponseWriter, data, meta interface{})

WriteOK writes 200 response

func WriteResponse

func WriteResponse(w http.ResponseWriter, code int, body interface{})

WriteResponse func

func WriteUnauthorized

func WriteUnauthorized(w http.ResponseWriter, details interface{})

WriteUnauthorized writes 401 response

func WriteValidationError

func WriteValidationError(w http.ResponseWriter, err error)

WriteValidationError writes 400 or 500 response

Types

type DataResponse

type DataResponse struct {
	Data interface{} `json:"data"`
	Meta interface{} `json:"meta,omitempty"`
}

DataResponse struct

func NewDataResponse

func NewDataResponse(data, meta interface{}) *DataResponse

NewDataResponse func

type ErrorResponse

type ErrorResponse struct {
	Error ErrorResponseError `json:"error"`
}

ErrorResponse struct

func NewErrorResponse

func NewErrorResponse(code string, details interface{}) *ErrorResponse

NewErrorResponse func

type ErrorResponseError

type ErrorResponseError struct {
	Code    string      `json:"code"`
	Details interface{} `json:"details,omitempty"`
}

ErrorResponseError struct

type SPAHandler

type SPAHandler struct {
	// contains filtered or unexported fields
}

func NewSPAHandler

func NewSPAHandler(fsys fs.FS, dirPath string, indexPath string) (*SPAHandler, error)

func (*SPAHandler) ServeHTTP

func (h *SPAHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ValidationError

type ValidationError struct {
	ErrorMap map[string]string
}

ValidationError error

func NewValidationError

func NewValidationError(errorMap map[string]string) *ValidationError

NewValidationError func

func (*ValidationError) Error

func (v *ValidationError) Error() string

Error method