httpform

Documentation

Index

• Variables
• func BindAndValidate[T any](w http.ResponseWriter, r *http.Request, dst *T, schema form.Schema[T], ...) bool
• func BindAndValidateFlat[T any](w http.ResponseWriter, r *http.Request, dst *T, schema form.Schema[T], ...) bool
• func BindAndValidateWithOptions[T any](w http.ResponseWriter, r *http.Request, dst *T, schema form.Schema[T], ...) bool
• func DecodeJSON(w http.ResponseWriter, r *http.Request, dst any, maxBytes int64) error
• func DecodeJSONLoose(w http.ResponseWriter, r *http.Request, dst any, maxBytes int64) error
• func ValidateJSON[T any](w http.ResponseWriter, r *http.Request, dst *T, schema form.Schema[T], ...) (form.Errors, error)
• func ValidateJSONLoose[T any](w http.ResponseWriter, r *http.Request, dst *T, schema form.Schema[T], ...) (form.Errors, error)
• func WriteValidationErrors(w http.ResponseWriter, errs form.Errors)
• func WriteValidationErrorsFlat(w http.ResponseWriter, errs form.Errors)
• type ErrorFormat
• type ResponseOptions
  • func DefaultResponseOptions() ResponseOptions
• type ValidationErrorResponse
• type ValidationFlatErrorResponse

Variables

var ErrBodyTooLarge = errors.New("request body too large")

Functions

func BindAndValidate

func BindAndValidate[T any](
	w http.ResponseWriter,
	r *http.Request,
	dst *T,
	schema form.Schema[T],
	maxBytes int64,
) bool

func BindAndValidateFlat

func BindAndValidateFlat[T any](
	w http.ResponseWriter,
	r *http.Request,
	dst *T,
	schema form.Schema[T],
	maxBytes int64,
) bool

func BindAndValidateWithOptions

func BindAndValidateWithOptions[T any](
	w http.ResponseWriter,
	r *http.Request,
	dst *T,
	schema form.Schema[T],
	maxBytes int64,
	opts ResponseOptions,
) bool

func DecodeJSON

func DecodeJSON(w http.ResponseWriter, r *http.Request, dst any, maxBytes int64) error

func DecodeJSONLoose

func DecodeJSONLoose(w http.ResponseWriter, r *http.Request, dst any, maxBytes int64) error

func ValidateJSON

func ValidateJSON[T any](w http.ResponseWriter, r *http.Request, dst *T, schema form.Schema[T], maxBytes int64) (form.Errors, error)

func ValidateJSONLoose

func ValidateJSONLoose[T any](w http.ResponseWriter, r *http.Request, dst *T, schema form.Schema[T], maxBytes int64) (form.Errors, error)

func WriteValidationErrors

func WriteValidationErrors(w http.ResponseWriter, errs form.Errors)

func WriteValidationErrorsFlat

func WriteValidationErrorsFlat(w http.ResponseWriter, errs form.Errors)

Types

type ErrorFormat

type ErrorFormat string

const (
	ErrorFormatMap  ErrorFormat = "map"
	ErrorFormatFlat ErrorFormat = "flat"
)

type ResponseOptions

type ResponseOptions struct {
	ErrorFormat        ErrorFormat
	ValidationMessage  string
	InvalidJSONMessage string
	UniqueCodes        bool
}

func DefaultResponseOptions

func DefaultResponseOptions() ResponseOptions

type ValidationErrorResponse

type ValidationErrorResponse struct {
	Message string                 `json:"message,omitempty"`
	Errors  map[string][]form.Code `json:"errors,omitempty"`
}

type ValidationFlatErrorResponse

type ValidationFlatErrorResponse struct {
	Message string           `json:"message,omitempty"`
	Errors  []form.ErrorItem `json:"errors,omitempty"`
}