README
¶
Form Decoder
A form decoder that decode request body of any types(xml, json, form, multipart form...) into a sctruct by same codebase.
By default, form decoder can handles the following content types:
- Form(application/x-www-form-urlencoded)
- Multipart Form(multipart/form-data)
- JSON(application/json)
- XML(application/xml)
Form and multipart form are built on top of gorilla schema, tag name is
schema.
Register allow to register particular decoder or replace default decoder for the specified content type.
Installation
$ go get clevergo.tech/form
Usage
import (
"net/http"
"clevergo.tech/form"
)
var decoders = form.New()
type user struct {
Username string `schema:"username" json:"username" xml:"username"`
Password string `schema:"password" json:"password" xml:"password"`
}
func init() {
// replaces multipart form decoder.
decoders.Register(form.ContentTypeMultipartForm, form.NewMultipartForm(10*1024*1024))
// registers other decoder
// decoders.Register(contentType, decoder)
}
func(w http.ResponseWriter, r *http.Request) {
u := user{}
if err := decoders.Decode(r, &u); err != nil {
http.Error(w, http.StatusInternalServerError, err.Error())
return
}
// ...
}
Example
Checkout example for details.
Documentation
¶
Overview ¶
Package form is a form decoder that decode request body into a struct.
Index ¶
Constants ¶
const ( ContentType = "Content-Type" ContentTypeForm = "application/x-www-form-urlencoded" ContentTypeMultipartForm = "multipart/form-data" ContentTypeJSON = "application/json" ContentTypeXML = "application/xml" )
Content type constants.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Decoder ¶
Decoder is a function that decode data from request into v.
func NewMultipartForm ¶
NewMultipartForm returns a multipart form decoder with the given schema decoder.
type Decoders ¶
Decoders is a map that mapping from content type to decoder.
type Validatable ¶
type Validatable interface {
Validate() error
}
Validatable indicates whether a value can be validated.
Source Files