http

Documentation

Overview

Package http defines the HTTP client used to interact with the Snyk Code API.

Index

• Constants
• func AddDefaultHeaders(req *http.Request, requestId string, orgId string, method string)
• func EncodeIfNeeded(method string, requestBody []byte) (*bytes.Buffer, error)
• type HTTPClient
  • func NewHTTPClient(httpClientFactory HTTPClientFactory, options ...OptionFunc) HTTPClient
• type HTTPClientFactory
  • func NewDefaultClientFactory() HTTPClientFactory
• type OptionFunc
  • func WithErrorReporter(errorReporter observability.ErrorReporter) OptionFunc
  • func WithInstrumentor(instrumentor observability.Instrumentor) OptionFunc
  • func WithLogger(logger *zerolog.Logger) OptionFunc
  • func WithRetryCount(retryCount int) OptionFunc

Constants

const NoRequestId = ""

Functions

func AddDefaultHeaders

func AddDefaultHeaders(req *http.Request, requestId string, orgId string, method string)

func EncodeIfNeeded

func EncodeIfNeeded(method string, requestBody []byte) (*bytes.Buffer, error)

EncodeIfNeeded returns a byte buffer for the requestBody. Depending on the request method, it may encode the buffer. (See http.mustBeEncoded for the list of methods which require encoding the request body.)

Types

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

func NewHTTPClient

func NewHTTPClient(
	httpClientFactory HTTPClientFactory,
	options ...OptionFunc,
) HTTPClient

type HTTPClientFactory

type HTTPClientFactory func() *http.Client

func NewDefaultClientFactory

func NewDefaultClientFactory() HTTPClientFactory

type OptionFunc

type OptionFunc func(*httpClient)

func WithErrorReporter

func WithErrorReporter(errorReporter observability.ErrorReporter) OptionFunc

func WithInstrumentor

func WithInstrumentor(instrumentor observability.Instrumentor) OptionFunc

func WithLogger

func WithLogger(logger *zerolog.Logger) OptionFunc

func WithRetryCount

func WithRetryCount(retryCount int) OptionFunc