binding

Documentation

Index

• Constants
• Variables
• func Bind(req *http.Request, obj interface{}) error
• func ContentType(req *http.Request) string
• func MapForm(ptr interface{}, values url.Values) error
• func MustBindWith(req *http.Request, obj interface{}, b Binding) (err error)
• type Binding
  • func Default(method, contentType string) Binding
• type BindingBody
• type BindingURI

Constants

const (
	MIMEJSON              = "application/json"
	MIMEHTML              = "text/html"
	MIMEXML               = "application/xml"
	MIMEXML2              = "text/xml"
	MIMEPlain             = "text/plain"
	MIMEPOSTForm          = "application/x-www-form-urlencoded"
	MIMEMultipartPOSTForm = "multipart/form-data"
	MIMEPROTOBUF          = "application/x-protobuf"
	MIMEMSGPACK           = "application/x-msgpack"
	MIMEMSGPACK2          = "application/msgpack"
	MIMEYAML              = "application/x-yaml"
)

Content-Type MIME of the most common data formats.

Variables

var (
	JSON          = jsonBinding{}
	XML           = xmlBinding{}
	Form          = formBinding{}
	Query         = queryBinding{}
	FormPost      = formPostBinding{}
	FormMultipart = formMultipartBinding{}
	ProtoBuf      = protobufBinding{}
	MsgPack       = msgpackBinding{}
	YAML          = yamlBinding{}
	URI           = uriBinding{}
)

These implement the Binding interface and can be used to bind the data present in the request to struct instances.

var EnableDecoderUseNumber = false

EnableDecoderUseNumber is used to call the UseNumber method on the JSON Decoder instance. UseNumber causes the Decoder to unmarshal a number into an interface{} as a Number instead of as a float64.

Functions

func Bind

func Bind(req *http.Request, obj interface{}) error

Bind checks the Content-Type to select a binding engine automatically, Depending the "Content-Type" header different bindings are used:

"application/json" --> JSON binding
"application/xml"  --> XML binding

otherwise --> returns an error. It parses the request's body as JSON if Content-Type == "application/json" using JSON or XML as a JSON input. It decodes the json payload into the struct specified as a pointer. It writes a 400 error and sets Content-Type header "text/plain" in the response if input is not valid.

func ContentType

func ContentType(req *http.Request) string

ContentType returns the Content-Type header of the request.

func MapForm

func MapForm(ptr interface{}, values url.Values) error

MapForm form values map to struct

func MustBindWith

func MustBindWith(req *http.Request, obj interface{}, b Binding) (err error)

MustBindWith binds the passed struct pointer using the specified binding engine. It will abort the request with HTTP 400 if any error occurs. See the binding package.

Types

type Binding

type Binding interface {
	Name() string
	Bind(*http.Request, interface{}) error
}

Binding describes the interface which needs to be implemented for binding the data present in the request such as JSON request body, query parameters or the form POST.

func Default

func Default(method, contentType string) Binding

Default returns the appropriate Binding instance based on the HTTP method and the content type.

type BindingBody

type BindingBody interface {
	Binding
	BindBody([]byte, interface{}) error
}

BindingBody adds BindBody method to Binding. BindBody is similar with Bind, but it reads the body from supplied bytes instead of req.Body.

type BindingURI

type BindingURI interface {
	Name() string
	BindURI(map[string][]string, interface{}) error
}

BindingURI adds BindUri method to Binding. BindUri is similar with Bind, but it read the Params.