httputil

Documentation

Overview

Package httputil implements http helpers

Index

• func AuthBearer(auth string) string
• func ExpectStatus(want int, got int) error
• func StdErrMsg(code int) string
• func ValidationErrMsg(err validator.FieldError) string
• type Client
  • func (c *Client) DelJSON(path string, payload any, destPtr any) (int, error)
  • func (c *Client) Get(path string) ([]byte, int, error)
  • func (c *Client) GetJSON(path string, destPtr any) (int, error)
  • func (c *Client) PostJSON(path string, payload any, destPtr any) (int, error)
  • func (c *Client) PutJSON(path string, payload any, destPtr any) (int, error)
  • func (c *Client) Req(method string, path string, payload any) (*http.Response, error)
• type Err
• type ErrResponse
  • func NewErr(code int, msg string) *ErrResponse
  • func NewErrFrom(err error) *ErrResponse
  • func NewValidationErr(errors validator.ValidationErrors) *ErrResponse
  • func (e *ErrResponse) WriteJSON(w http.ResponseWriter)
• type ValidationErr

Functions

func AuthBearer

func AuthBearer(auth string) string

AuthBearer extracts bearer token value from Authorization header

func ExpectStatus

func ExpectStatus(want int, got int) error

ExpectStatus returns error if actual status not equal to expected one

func StdErrMsg

func StdErrMsg(code int) string

StdErrMsg returns standard error message by code

func ValidationErrMsg

func ValidationErrMsg(err validator.FieldError) string

ValidationErrMsg returns validation error message by validate tag

Types

type Client

type Client struct {
	BaseURL string
	Header  http.Header
	Cookies []http.Cookie
	Timeout time.Duration
}

Client implements base http client

func (*Client) DelJSON

func (c *Client) DelJSON(path string, payload any, destPtr any) (int, error)

DelJSON makes delete request and decodes response body as json

func (*Client) Get

func (c *Client) Get(path string) ([]byte, int, error)

Get makes get request and returns response body

func (*Client) GetJSON

func (c *Client) GetJSON(path string, destPtr any) (int, error)

GetJSON makes get request and decodes response body as json

func (*Client) PostJSON

func (c *Client) PostJSON(path string, payload any, destPtr any) (int, error)

PostJSON makes post request and decodes response body as json

func (*Client) PutJSON

func (c *Client) PutJSON(path string, payload any, destPtr any) (int, error)

PutJSON makes put request and decodes response body as json

func (*Client) Req

func (c *Client) Req(method string, path string, payload any) (*http.Response, error)

Req performs new http request with given method, path and optional json body

type Err

type Err struct {
	Code  int             `json:"code"`
	Msg   string          `json:"msg"`
	Items []ValidationErr `json:"items,omitempty"`
}

Err represents generic api error

type ErrResponse

type ErrResponse struct {
	Error Err `json:"error"`
}

ErrResponse represents json container for error object

func NewErr

func NewErr(code int, msg string) *ErrResponse

NewErr returns new standard api error value

func NewErrFrom

func NewErrFrom(err error) *ErrResponse

NewErrFrom returns new error value from given error

func NewValidationErr

func NewValidationErr(errors validator.ValidationErrors) *ErrResponse

NewValidationErr returns new validation error value

func (*ErrResponse) WriteJSON

func (e *ErrResponse) WriteJSON(w http.ResponseWriter)

WriteJSON responds json error with http.ResponseWriter

type ValidationErr

type ValidationErr struct {
	Subject string `json:"subject"`
	Msg     string `json:"msg"`
}

ValidationErr represents validation error