123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119 |
- // Copyright 2014 Manu Martinez-Almeida. All rights reserved.
- // Use of this source code is governed by a MIT style
- // license that can be found in the LICENSE file.
- //go:build !nomsgpack
- // +build !nomsgpack
- package binding
- import "net/http"
- // Content-Type MIME of the most common data formats.
- 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"
- )
- // 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.
- type Binding interface {
- Name() string
- Bind(*http.Request, interface{}) error
- }
- // These implement the Binding interface and can be used to bind the data
- // present in the request to struct instances.
- var (
- JSON = jsonBinding{}
- XML = xmlBinding{}
- Form = formBinding{}
- Query = queryBinding{}
- FormPost = formPostBinding{}
- FormMultipart = formMultipartBinding{}
- /*
- ProtoBuf = protobufBinding{}
- MsgPack = msgpackBinding{}
- YAML = yamlBinding{}
- //*/
- URI = uriBinding{}
- Header = headerBinding{}
- )
- // Default returns the appropriate Binding instance based on the HTTP method
- // and the content type.
- func Default(method, contentType string) Binding {
- if method == http.MethodGet {
- return Form
- }
- switch contentType {
- case MIMEJSON:
- return JSON
- case MIMEXML, MIMEXML2:
- return XML
- /*
- case MIMEPROTOBUF:
- return ProtoBuf
- case MIMEMSGPACK, MIMEMSGPACK2:
- return MsgPack
- case MIMEYAML:
- return YAML
- //*/
- case MIMEMultipartPOSTForm:
- return FormMultipart
- default: // case MIMEPOSTForm:
- return Form
- }
- }
- // 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 Bind(req *http.Request, obj interface{}) error {
- b := Default(req.Method, ContentType(req))
- return MustBindWith(req, obj, b)
- }
- // BindHeader bind with header
- func BindHeader(req *http.Request, obj interface{}) error {
- return Header.Bind(req, obj)
- }
- // 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.
- func MustBindWith(req *http.Request, obj interface{}, b Binding) (err error) {
- return b.Bind(req, obj)
- }
- // ContentType returns the Content-Type header of the request.
- func ContentType(req *http.Request) string {
- return filterFlags(req.Header.Get("Content-Type"))
- }
- func filterFlags(content string) string {
- for i, char := range content {
- if char == ' ' || char == ';' {
- return content[:i]
- }
- }
- return content
- }
|