formats

package

v0.0.0-...-c5b96c6 Latest Latest Go to latest Published: Mar 2, 2018 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ryankurte/go-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func BindFormatter(t string, f Formatter)
func Decode(t string, r *http.Request, i interface{}) error
func Encode(accepts string, i interface{}) (string, string, error)
func ParseAcceptHeader(accept string) []string
func RemoveFormatter(t string)
type Form
- func NewForm() Form
- func (j Form) Decode(r *http.Request, i interface{}) error
- func (j Form) Encode(o interface{}) (string, error)
type Formatter
type JSON
- func NewJSON() JSON
- func (j JSON) Decode(r *http.Request, i interface{}) error
- func (j JSON) Encode(o interface{}) (string, error)
type XML
- func NewXML() XML
- func (j XML) Decode(r *http.Request, i interface{}) error
- func (j XML) Encode(o interface{}) (string, error)
type YAML
- func NewYAML() YAML
- func (j YAML) Decode(r *http.Request, i interface{}) error
- func (j YAML) Encode(o interface{}) (string, error)

Constants ¶

View Source

const FormResourceType string = "application/x-www-form-urlencoded"

View Source

const JSONResourceType string = "application/json"

View Source

const XMLResourceType string = "application/xml"

View Source

const YAMLResourceType string = "application/yaml"

Variables ¶

View Source

var DefaultRequestFormatter = JSONResourceType

DefaultRequestFormatter defines the default decoding in the absence of headers

View Source

var DefaultResponseFormatter = JSONResourceType

DefaultResponseFormatter defines the default encoding in the absence of headers

Functions ¶

func BindFormatter ¶

func BindFormatter(t string, f Formatter)

BindFormatter Bind an alternate formatter implementation

func Decode ¶

func Decode(t string, r *http.Request, i interface{}) error

Decode Generic decode function (uses http accept header)

func Encode ¶

func Encode(accepts string, i interface{}) (string, string, error)

Encode Generic encode function

func ParseAcceptHeader ¶

func ParseAcceptHeader(accept string) []string

ParseAcceptHeader Parses an HTTP accept header to return an ordered list of content types

func RemoveFormatter ¶

func RemoveFormatter(t string)

RemoveFormatter Remove a formatter implementation

Types ¶

type Form ¶

type Form struct {
}

func NewForm ¶

func NewForm() Form

func (Form) Decode ¶

func (j Form) Decode(r *http.Request, i interface{}) error

func (Form) Encode ¶

func (j Form) Encode(o interface{}) (string, error)

type Formatter ¶

type Formatter interface {
	Encode(o interface{}) (string, error)
	Decode(r *http.Request, i interface{}) error
}

Formatter Defines a formatter interface

type JSON ¶

type JSON struct {
}

func NewJSON ¶

func NewJSON() JSON

func (JSON) Decode ¶

func (j JSON) Decode(r *http.Request, i interface{}) error

func (JSON) Encode ¶

func (j JSON) Encode(o interface{}) (string, error)

type XML ¶

type XML struct {
}

func NewXML ¶

func NewXML() XML

func (XML) Decode ¶

func (j XML) Decode(r *http.Request, i interface{}) error

func (XML) Encode ¶

func (j XML) Encode(o interface{}) (string, error)

type YAML ¶

type YAML struct {
}

func NewYAML ¶

func NewYAML() YAML

func (YAML) Decode ¶

func (j YAML) Decode(r *http.Request, i interface{}) error

func (YAML) Encode ¶

func (j YAML) Encode(o interface{}) (string, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL