httprequest

Documentation

Index

• Constants
• func Body(v any, r *http.Request, accept ...string) error
• func Query(v any, req url.Values) error
• type Unmarshaller

Constants

const (
	ContentTypeJson           = "application/json"
	ContentTypeTextXml        = "text/xml"
	ContentTypeApplicationXml = "application/xml"
	ContentTypeText           = "text/"
	ContentTypeBinary         = "application/octet-stream"
	ContentTypeFormData       = "multipart/form-data"
	ContentTypeUrlEncoded     = "application/x-www-form-urlencoded"
)

Functions

func Body

func Body(v any, r *http.Request, accept ...string) error

Body reads the body of an HTTP request and decodes it into v. You can include the mimetypes that are acceptable, otherwise it will read the body based on the content type. If does not close the body of the request, which should be done by the caller. v can be a io.Writer, in which case the body is copied into it. v can be a struct, in which case the body is decoded into it.

func Query

func Query(v any, req url.Values) error

Query copies the query parameters from a request into a structure, which should be a pointer to a struct. The struct should have json tags. No attempt is made to validate the query parameters beyond the conversion from string or []string into the appropriate type. It can use the MarshalJSON interface to convert a string into a custom type.

Types

type Unmarshaller

type Unmarshaller interface {
	// Convert a string into a custom type
	UnmarshalJSON([]byte) error
}