Documentation
¶
Overview ¶
Package httpx includes various HTTP utilities.
Index ¶
- func Copy(w http.ResponseWriter, res *http.Response) error
- func DecodeDeepObject(values url.Values, obj any) error
- func EncodeDeepObject(obj any) (url.Values, error)
- func FillPathArguments(u string) (resolved string, err error)
- func IsLocalhostAddress(r *http.Request) bool
- func IsPrivateIPAddress(r *http.Request) bool
- func JoinHostAndPath(host string, path string) string
- func MethodWithBody(method string) bool
- func MustNewRequest(method string, url string, body any) *http.Request
- func MustNewRequestWithContext(ctx context.Context, method string, url string, body any) *http.Request
- func NewRequest(method string, url string, body any) (*http.Request, error)
- func NewRequestWithContext(ctx context.Context, method string, url string, body any) (*http.Request, error)
- func ParseRequestBody(r *http.Request, data any) error
- func ParseURL(rawURL string) (canonical *url.URL, err error)
- func PathValues(r *http.Request, routePath string) (result url.Values, err error)
- func ReadInputPayload(r *http.Request, route string, in any) (err error)
- func ReadOutputPayload(res *http.Response, out any) (err error)
- func ResolveURL(base string, relative string) (resolved string, err error)
- func SetPathValues(r *http.Request, routePath string) error
- func SetRequestBody(r *http.Request, body any) error
- func ValidateHostname(hostname string) error
- func WriteInputPayload(method string, in any) (query url.Values, body any, err error)
- func WriteOutputPayload(w http.ResponseWriter, out any) (err error)
- type BodyReader
- type DefragRequest
- type DefragResponse
- type FragRequest
- type FragResponse
- type QArgs
- type ResponseRecorder
- func (rr *ResponseRecorder) Clear()
- func (rr *ResponseRecorder) ClearBody()
- func (rr *ResponseRecorder) ClearHeader()
- func (rr *ResponseRecorder) ContentLength() int
- func (rr *ResponseRecorder) Header() http.Header
- func (rr *ResponseRecorder) Result() *http.Response
- func (rr *ResponseRecorder) StatusCode() int
- func (rr *ResponseRecorder) Write(b []byte) (int, error)
- func (rr *ResponseRecorder) WriteHeader(statusCode int)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Copy ¶
func Copy(w http.ResponseWriter, res *http.Response) error
Copy writes the http.Response to the http.ResponseWriter. Headers are added, the body is appended, and the status code is overwritten. It is possible for this function to take ownership of the bytes of the body of the http.Response so do not modify them.
func DecodeDeepObject ¶
DecodeDeepObject decodes an object from a string representation with bracketed nested fields names. For example, color[R]=100&color[G]=200&color[B]=150 .
func EncodeDeepObject ¶
EncodeDeepObject encodes an object into string representation with bracketed nested fields names. For example, color[R]=100&color[G]=200&color[B]=150 .
func FillPathArguments ¶
FillPathArguments transfers query arguments into path arguments, if present.
func IsLocalhostAddress ¶
IsLocalhostAddress checks if the request's remote address is the local host.
func IsPrivateIPAddress ¶
IsPrivateIPAddress checks if the request's remote address is on the local subnets, e.g. 192.168.X.X or 10.X.X.X.
func JoinHostAndPath ¶
JoinHostAndPath combines the path shorthand with a hostname.
func MethodWithBody ¶ added in v1.22.0
MethodWithBody returns true if the HTTP method typically accepts a request body.
func MustNewRequest ¶
MustNewRequest wraps NewRequestWithContext with the background context. It panics on error.
func MustNewRequestWithContext ¶
func MustNewRequestWithContext(ctx context.Context, method string, url string, body any) *http.Request
MustNewRequestWithContext returns a new http.Request given a method, URL, and optional body. It panics on error. Arguments of type io.Reader, io.ReadCloser, []byte and string are serialized in binary form. url.Values and QArgs are serialized as form data. All other types are serialized as JSON. The Content-Type Content-Length headers will be set to match the body if they can be determined and unless already set.
func NewRequest ¶
NewRequest wraps NewRequestWithContext with the background context.
func NewRequestWithContext ¶
func NewRequestWithContext(ctx context.Context, method string, url string, body any) (*http.Request, error)
NewRequestWithContext returns a new http.Request given a method, URL, and optional body. Arguments of type io.Reader, io.ReadCloser, []byte and string are serialized in binary form. url.Values and QArgs are serialized as form data. All other types are serialized as JSON. The Content-Type Content-Length headers will be set to match the body if they can be determined and unless already set.
func ParseRequestBody ¶
ParseRequestBody parses the body of an incoming request and populates the fields of a data object. It supports JSON and URL-encoded form data content types. Use json tags to designate the name of the argument to map to each field.
func ParseURL ¶
ParseURL returns a canonical version of the parsed URL with the scheme and port filled in if omitted. This method should only be used on internal URLs because it limits the hostname to certain specifications.
func PathValues ¶ added in v1.19.0
PathValues pulls the path values from the request given a parameterized route path such as /obj/{id}/{}. The path values should have been previously set on the request with SetPathValue.
func ReadInputPayload ¶ added in v1.22.0
ReadInputPayload parses the body, path arguments, and query arguments of an incoming request and populates them into an object. The body can contain a JSON payload or URL-encoded form data. Use JSON tags to designate the name of the argument to map to each field. An argument name can be hierarchical using either notation "a[b][c]" or "a.b.c", in which case it is read into the corresponding nested field.
func ReadOutputPayload ¶ added in v1.22.0
ReadOutputPayload reads the HTTP response into the output payload. It enables the HTTPResponseBody and HTTPStatusCode magic arguments.
func ResolveURL ¶
ResolveURL resolves a URL in relation to the endpoint's base path.
func SetPathValues ¶ added in v1.19.0
SetPathValues compares the request's actual path against a parameterized route path such as /obj/{id}/{}, and sets the path values of the request appropriately.
func SetRequestBody ¶
SetRequestBody sets the body of the request. Arguments of type io.Reader, io.ReadCloser, []byte and string are serialized in binary form. url.Values and QArgs are serialized as form data. All other types are serialized as JSON. The Content-Type Content-Length headers will be set to match the body if they can be determined and unless already set.
func ValidateHostname ¶ added in v1.21.0
ValidateHostname indicates if the hostname is a valid microservice hostname. Hostnames must contain only alphanumeric characters, hyphens, underscores and dot separators, and be 252 characters or less.
func WriteInputPayload ¶ added in v1.22.0
WriteInputPayload determines how to deliver the input payload, via query arguments or the body of the request. It enables the HTTPRequestBody magic argument.
func WriteOutputPayload ¶ added in v1.22.0
func WriteOutputPayload(w http.ResponseWriter, out any) (err error)
WriteOutputPayload writes the output payload to the HTTP response as JSON. It enables the HTTPStatusCode and HTTPResponseBody magic arguments.
Types ¶
type BodyReader ¶
type BodyReader struct {
// contains filtered or unexported fields
}
BodyReader is used to wrap bytes in a closer+reader while allowing access to the underlying bytes.
func NewBodyReader ¶
func NewBodyReader(b []byte) *BodyReader
NewBodyReader creates a new closer+reader for the request body while allowing access to the underlying bytes.
func (*BodyReader) Bytes ¶
func (br *BodyReader) Bytes() []byte
Bytes gives access to the underlying bytes.
func (*BodyReader) Close ¶
func (br *BodyReader) Close() error
Read implements the io.Closer interface.
func (*BodyReader) Len ¶ added in v1.14.0
func (br *BodyReader) Len() int
Len is the length of the underlying bytes.
func (*BodyReader) Read ¶
func (br *BodyReader) Read(p []byte) (n int, err error)
Read implements the io.Reader interface.
func (*BodyReader) Reset ¶
func (br *BodyReader) Reset()
Reset resets the underlying reader to the beginning.
type DefragRequest ¶
type DefragRequest struct {
// contains filtered or unexported fields
}
DefragRequest merges together multiple fragments back into a single HTTP request
func NewDefragRequest ¶
func NewDefragRequest() *DefragRequest
NewDefragRequest creates a new request integrator.
func (*DefragRequest) Add ¶
func (st *DefragRequest) Add(r *http.Request) (final bool, err error)
Add a fragment to be integrated. The integrated request is returned if this was the last fragment.
func (*DefragRequest) Integrated ¶
func (st *DefragRequest) Integrated() (integrated *http.Request, err error)
Integrated returns all the fragments have been collected as a single HTTP request.
func (*DefragRequest) LastActivity ¶
func (st *DefragRequest) LastActivity() time.Duration
LastActivity indicates how long ago was the last fragment added.
type DefragResponse ¶
type DefragResponse struct {
// contains filtered or unexported fields
}
DefragResponse merges together multiple fragments back into a single HTTP response
func NewDefragResponse ¶
func NewDefragResponse() *DefragResponse
NewDefragResponse creates a new response integrator.
func (*DefragResponse) Add ¶
func (st *DefragResponse) Add(r *http.Response) (final bool, err error)
Add a fragment to be integrated. The integrated response is returned if this was the last fragment.
func (*DefragResponse) Integrated ¶
func (st *DefragResponse) Integrated() (integrated *http.Response, err error)
Integrated returns all the fragments have been collected as a single HTTP response.
func (*DefragResponse) LastActivity ¶
func (st *DefragResponse) LastActivity() time.Duration
LastActivity indicates how long ago was the last fragment added.
type FragRequest ¶
type FragRequest struct {
// contains filtered or unexported fields
}
FragRequest transforms an HTTP request into one or more fragments that do not exceed a given size. Fragmenting is needed because NATS imposes a maximum size for messages
func NewFragRequest ¶
func NewFragRequest(r *http.Request, fragmentSize int64) (*FragRequest, error)
NewFragRequest creates a new request fragmentor
type FragResponse ¶
type FragResponse struct {
// contains filtered or unexported fields
}
FragResponse transforms an HTTP response into one or more fragments that do not exceed a given size. Fragmenting is needed because NATS imposes a maximum size for messages
func NewFragResponse ¶
func NewFragResponse(r *http.Response, fragmentSize int64) (*FragResponse, error)
NewFragResponse creates a new response fragmentor
type QArgs ¶
QArgs faciliates the creation of URL query arguments for the common case where there is only one value per key. Values of any type are converted to a string. Keys are case-sensitive.
Usage:
u := "https://example.com/path?"+QArgs{
"hello": "World",
"number": 6,
"id", key
}.Encode()
func (QArgs) Encode ¶
Encode encodes the values into “URL encoded” form ("bar=baz&foo=quux") sorted by key.
type ResponseRecorder ¶
type ResponseRecorder struct {
// contains filtered or unexported fields
}
ResponseRecorder is used to record HTTP responses.
func NewResponseRecorder ¶
func NewResponseRecorder() *ResponseRecorder
NewResponseRecorder creates a new response recorder. The recorder is modifiable even after the body was written because it keeps the entire response in memory.
func (*ResponseRecorder) Clear ¶
func (rr *ResponseRecorder) Clear()
Clear resets all headers, body and status code.
func (*ResponseRecorder) ClearBody ¶ added in v1.13.1
func (rr *ResponseRecorder) ClearBody()
ClearBody resets the body's content.
func (*ResponseRecorder) ClearHeader ¶ added in v1.13.1
func (rr *ResponseRecorder) ClearHeader()
ClearHeader resets the headers.
func (*ResponseRecorder) ContentLength ¶
func (rr *ResponseRecorder) ContentLength() int
ContentLength returns the total number of bytes written to the body of the response.
func (*ResponseRecorder) Header ¶
func (rr *ResponseRecorder) Header() http.Header
Header enables setting headers. It implements the http.ResponseWriter interface.
func (*ResponseRecorder) Result ¶
func (rr *ResponseRecorder) Result() *http.Response
Result returns the response generated by the recorder.
func (*ResponseRecorder) StatusCode ¶
func (rr *ResponseRecorder) StatusCode() int
StatusCode returns the status code set for the response. If unset, the default is http.StatusOK 200.
func (*ResponseRecorder) Write ¶
func (rr *ResponseRecorder) Write(b []byte) (int, error)
Write writes bytes to the body of the response. It implements the http.ResponseWriter interface.
func (*ResponseRecorder) WriteHeader ¶
func (rr *ResponseRecorder) WriteHeader(statusCode int)
WriteHeader writes the header to the response. It implements the http.ResponseWriter interface.
Source Files