form

README

Form Decoder

A form deocder that decode request body of any types(xml, json, form, multipart form...) into a scturct by same codebase.

Usage

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)

Register allow to register particular decoder or replace default decoder for the specified content type.

package main

import (
	"fmt"
	"net/http"

	"github.com/clevergo/clevergo"
	"github.com/clevergo/form"
)

type User struct {
	Username string `json:"username" xml:"username"`
	Password string `json:"password" xml:"password"`
}

func login(w http.ResponseWriter, r *http.Request) {
	user := User{}
	err := form.Decode(r, &user)
	if err != nil {
		http.Error(w, err.Error(), http.StatusForbidden)
		return
	}
	fmt.Fprintf(w, "username: %s, password: %s", user.Username, user.Password)
}

func main() {
	app := clevergo.New("localhost:1234")
	app.Post("/login", login)
	app.ListenAndServe()
}

$ curl -XPOST -d "username=foo&password=bar"  http://localhost:1234/login
username: foo, password: bar

$ curl -XPOST -H "Content-Type: application/json" -d '{"username":"foo", "password": "bar"}' http://localhost:1234/login
username: foo, password: bar

$ curl -XPOST -H "Content-Type: application/xml" -d '<xml><username>foo</username><password>bar</password></xml>' http://localhost:1234/login
username: foo, password: bar

$ curl -XPOST -F "username=foo" -F "password=bar" http://localhost:1234/login
username: foo, password: bar

Documentation

Overview

Package form is a form decoder that decode request body into a struct.

Index

• Constants
• func Decode(r *http.Request, v interface{}) error
• func JSON(r *http.Request, v interface{}) error
• func Register(contentType string, decoder Decoder)
• func XML(r *http.Request, v interface{}) error
• type Decoder
  • func NewForm(decoder *schema.Decoder) Decoder
  • func NewMultipartForm(maxMemory int64) Decoder
• type Decoders
  • func New() *Decoders
  • func (d *Decoders) Decode(r *http.Request, v interface{}) error
  • func (d *Decoders) Register(contentType string, decoder Decoder)

Constants

const (
	ContentType              = "Content-Type"
	ContentTypeForm          = "application/x-www-form-urlencoded"
	ContentTypeMultipartForm = "multipart/form-data"
	ContentTypeJSON          = "application/json"
	ContentTypeXML           = "application/xml"
)

Content type constants.

Functions

func Decode

func Decode(r *http.Request, v interface{}) error

Decode data from a request into v, v should be a pointer.

func JSON

func JSON(r *http.Request, v interface{}) error

JSON is a JSON decoder.

func Register

func Register(contentType string, decoder Decoder)

Register a decoder for the given content type.

func XML

func XML(r *http.Request, v interface{}) error

XML is an XML decoder.

Types

type Decoder

type Decoder func(req *http.Request, v interface{}) error

Decoder is a function that decode data from request into v.

func NewForm

func NewForm(decoder *schema.Decoder) Decoder

NewForm returns a post form decoder with the given schema decoder.

func NewMultipartForm

func NewMultipartForm(maxMemory int64) Decoder

NewMultipartForm returns a multipart form decoder with the given schema decoder.

type Decoders

type Decoders map[string]Decoder

Decoders is a map that mapping from content type to decoder.

func New

func New() *Decoders

New returns a decoders.

func (*Decoders) Decode

func (d *Decoders) Decode(r *http.Request, v interface{}) error

Decode data from a request into v, v should be a pointer.

func (*Decoders) Register

func (d *Decoders) Register(contentType string, decoder Decoder)

Register a decoder for the given content type.