The highest tagged major version is
Documentation
¶
Overview ¶
Package compat provides wrapper functions that allow a simple usage of the jsonapi package together with the standard http package.
Index ¶
- func ParseRequest(r *http.Request, prefix string) (*jsonapi.Request, error)
- func WriteError(w http.ResponseWriter, err error) error
- func WriteErrorList(w http.ResponseWriter, errors ...*jsonapi.Error) error
- func WriteResource(w http.ResponseWriter, status int, resource *jsonapi.Resource, ...) error
- func WriteResources(w http.ResponseWriter, status int, resources []*jsonapi.Resource, ...) error
- func WriteResponse(res http.ResponseWriter, status int, doc *jsonapi.Document) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ParseRequest ¶
ParseRequest is a convenience method to parse a standard http.Request.
See: https://godoc.org/github.com/gonfire/jsonapi#ParseRequest.
func WriteError ¶
func WriteError(w http.ResponseWriter, err error) error
WriteError is a convenience method to write to a standard http.ResponseWriter.
See: https://godoc.org/github.com/gonfire/jsonapi#WriteError.
func WriteErrorList ¶
func WriteErrorList(w http.ResponseWriter, errors ...*jsonapi.Error) error
WriteErrorList is a convenience method to write to a standard http.ResponseWriter.
See: https://godoc.org/github.com/gonfire/jsonapi#WriteErrorList.
func WriteResource ¶
func WriteResource(w http.ResponseWriter, status int, resource *jsonapi.Resource, links *jsonapi.DocumentLinks, included ...*jsonapi.Resource) error
WriteResource is a convenience method to write to a standard http.ResponseWriter.
See: https://godoc.org/github.com/gonfire/jsonapi#WriteResource.
func WriteResources ¶
func WriteResources(w http.ResponseWriter, status int, resources []*jsonapi.Resource, links *jsonapi.DocumentLinks, included ...*jsonapi.Resource) error
WriteResources is a convenience method to write to a standard http.ResponseWriter.
See: https://godoc.org/github.com/gonfire/jsonapi#WriteResources.
func WriteResponse ¶
WriteResponse is a convenience method to write to a standard http.ResponseWriter.
See: https://godoc.org/github.com/gonfire/jsonapi#WriteResponse.
Types ¶
This section is empty.
Source Files