goutils

README

goutils

Go utils.

Documentation

Index

• func NotFoundHandler() http.Handler
• func TokenFromHeader(r *http.Request) string
• func WriteBadRequest(w http.ResponseWriter, details any)
• func WriteCreated(w http.ResponseWriter, data, meta any)
• func WriteInternalError(w http.ResponseWriter, details any)
• func WriteNoContent(w http.ResponseWriter)
• func WriteNotFound(w http.ResponseWriter, details any)
• func WriteOK(w http.ResponseWriter, data, meta any)
• func WriteResponse(w http.ResponseWriter, code int, body any)
• func WriteUnauthorized(w http.ResponseWriter, details any)
• func WriteValidationError(w http.ResponseWriter, err error)
• type DataResponse
  • func NewDataResponse(data, meta any) *DataResponse
• type ErrorResponse
  • func NewErrorResponse(code string, details any) *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 (err ValidationError) Error() string

Functions

func NotFoundHandler

func NotFoundHandler() http.Handler

func TokenFromHeader

func TokenFromHeader(r *http.Request) string

func WriteBadRequest

func WriteBadRequest(w http.ResponseWriter, details any)

func WriteCreated

func WriteCreated(w http.ResponseWriter, data, meta any)

func WriteInternalError

func WriteInternalError(w http.ResponseWriter, details any)

func WriteNoContent

func WriteNoContent(w http.ResponseWriter)

func WriteNotFound

func WriteNotFound(w http.ResponseWriter, details any)

func WriteOK

func WriteOK(w http.ResponseWriter, data, meta any)

func WriteResponse

func WriteResponse(w http.ResponseWriter, code int, body any)

func WriteUnauthorized

func WriteUnauthorized(w http.ResponseWriter, details any)

func WriteValidationError

func WriteValidationError(w http.ResponseWriter, err error)

Types

type DataResponse

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

func NewDataResponse

func NewDataResponse(data, meta any) *DataResponse

type ErrorResponse

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

func NewErrorResponse

func NewErrorResponse(code string, details any) *ErrorResponse

type ErrorResponseError

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

type SPAHandler

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

func NewSPAHandler

func NewSPAHandler(fsys fs.FS, dirPath string, indexPath string, prepareResponse func(http.ResponseWriter, *http.Request, bool)) (*SPAHandler, error)

func (*SPAHandler) ServeHTTP

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

type ValidationError

type ValidationError struct {
	Errors map[string][]string
}

func (ValidationError) Error

func (err ValidationError) Error() string