resttestutil

Documentation

Index

• func ConstructInternalPath(subpath string, options ...ConstructURLOption) (string, error)
• func MustConstructInternalPath(subpath string, options ...ConstructURLOption) string
• func ReqWithAPIKey(apiKey string) client.RequestEditorFn
• type ConstructURLOption
  • func WithQueryParams(params any) ConstructURLOption

Functions

func ConstructInternalPath

func ConstructInternalPath(subpath string, options ...ConstructURLOption) (string, error)

ConstructInternalPath constructs a URL with encoded parameters based on the non-nil fields of the provided struct via the form tag. Required path prefixes are added automatically.

func MustConstructInternalPath

func MustConstructInternalPath(subpath string, options ...ConstructURLOption) string

MustConstructInternalPath constructs a URL with encoded parameters based on the non-nil fields of the provided struct. Required path prefixes are added automatically. It panics if an error occurs during URL construction.

func ReqWithAPIKey

func ReqWithAPIKey(apiKey string) client.RequestEditorFn

Types

type ConstructURLOption

type ConstructURLOption func(*constructURLOptions)

ConstructURLOption is the type for options that can be passed to ConstructInternalPath.

func WithQueryParams

func WithQueryParams(params any) ConstructURLOption

WithQueryParams specifies the struct containing the query parameters.