httphelper

README

httphelper

Helpers for Go's http package.

Documentation

Overview

Package httphelper contains http package helpers.

Index

• Variables
• func AuthBasic(userid, password string) string
• func ErrorOptionWithMessage() func(o *ErrorOptions)
• func ErrorOptionWithObject() func(o *ErrorOptions)
• func IsNotStatusOK(rs *http.Response) bool
• func JsonBody(in any) (io.ReadCloser, error)
• func JsonReader(in any) (*bytes.Reader, error)
• func ReqBody[E any](client *http.Client, rq *http.Request, isError func(*http.Response) bool) ([]byte, error)
• func ReqJson[O, E any](client *http.Client, rq *http.Request, isError func(*http.Response) bool) (*O, error)
• type Error
  • func NewError[T any](rs *http.Response, opts ...func(o *ErrorOptions)) (*Error[T], error)
  • func (e *Error[T]) Error() string
• type ErrorOptions

Variables

var ErrEmptyResponseBody = errors.New("empty response body")

Functions

func AuthBasic

func AuthBasic(userid, password string) string

AuthBasic returns Basic authorization value.

func ErrorOptionWithMessage

func ErrorOptionWithMessage() func(o *ErrorOptions)

ErrorOptionWithMessage turns on Error's Message string deserialization from HTTP response body.

func ErrorOptionWithObject

func ErrorOptionWithObject() func(o *ErrorOptions)

ErrorOptionWithObject turns on Error's Object JSON deserialization from HTTP response body.

func IsNotStatusOK

func IsNotStatusOK(rs *http.Response) bool

IsNotStatusOK determines whether r.StatusCode is not http.StatusOK.

func JsonBody

func JsonBody(in any) (io.ReadCloser, error)

JsonBody creates http Body containing JSON-encoded 'in'. If 'in' is nil, http.NoBody is returned.

func JsonReader

func JsonReader(in any) (*bytes.Reader, error)

JsonReader creates bytes.Reader containing JSON-encoded 'in' to use as body with http.NewRequest or http.NewRequestWithContext. If 'in' is nil, nil is returned.

func ReqBody

func ReqBody[E any](client *http.Client, rq *http.Request, isError func(*http.Response) bool) ([]byte, error)

ReqBody sends an http.Request by http.Client and returns the contents of the response body.

If 'isError' is not nil and returns 'true', httphelper.Error is returned. httphelper.Error.Object of type 'E' is JSON-decoded from the response body. If response body does not contain JSON-encoded 'E', but contains a string, this string is returned in httphelper.Error.Message field.

Pass generichelper.NoType as 'E' to omit processing of httphelper.Error.Object.

func ReqJson

func ReqJson[O, E any](client *http.Client, rq *http.Request, isError func(*http.Response) bool) (*O, error)

ReqJson sends an http.Request by http.Client and returns output object of type 'O' passed JSON-encoded as the response body.

If 'isError' is not nil and returns 'true', httphelper.Error is returned. httphelper.Error.Object of type 'E' is JSON-decoded from the response body. If response body does not contain JSON-encoded 'E', but contains a string, this string is returned in httphelper.Error.Message field.

Pass generichelper.NoType as corresponding type argument to omit processing of either object.

Types

type Error

type Error[T any] struct {
	StatusCode int    `json:"status_code"`
	Status     string `json:"status"`
	Object     T      `json:"object,omitempty"`
	Message    string `json:"message,omitempty"`
}

Error represents a HTTP error. Object (if turned on in options) is deserialized from JSON read from HTTP response body (if any).

func NewError

func NewError[T any](rs *http.Response, opts ...func(o *ErrorOptions)) (*Error[T], error)

NewError creates Error from http.Response.

func (*Error[T]) Error

func (e *Error[T]) Error() string

Error implements the error interface.

type ErrorOptions

type ErrorOptions struct {
	// contains filtered or unexported fields
}

ErrorOptions contains Error options.