request

Documentation

Index

• Variables
• type Client
  • func NewClient(opts NewClientOptions) *Client
  • func (c *Client) WithCookies(cookies []*http.Cookie) *Client
  • func (c *Client) WithHeader(header http.Header) *Client
• type NewClientOptions
• type Operation
  • func NewOperation(method string, operationUrl string, body *bytes.Buffer, client *Client) (*Operation, error)
  • func NewOperationFromRequest(r *Request) *Operation
  • func (o *Operation) Clone() *Operation
  • func (operation *Operation) GetID() string
  • func (operation *Operation) GetPath() string
  • func (operation *Operation) GetSecuritySchemes() []auth.SecurityScheme
  • func (operation *Operation) GetTags() []string
  • func (operation *Operation) IsReachable() error
  • func (operation *Operation) NewRequest() (*Request, error)
  • func (operation *Operation) SetID(id string) *Operation
  • func (operation *Operation) SetSecuritySchemes(securitySchemes []auth.SecurityScheme) *Operation
  • func (operation *Operation) SetTags(tags []string) *Operation
  • func (operation *Operation) WithCookies(cookies []*http.Cookie) *Operation
  • func (operation *Operation) WithHeader(header http.Header) *Operation
  • func (operation *Operation) WithOpenapiOperation(openapiOperation openapi3.Operation) *Operation
• type Operations
  • func (o Operations) Len() int
  • func (o Operations) Less(i, j int) bool
  • func (o Operations) Swap(i, j int)
• type Request
  • func NewRequest(method string, reqUrl string, body io.Reader, client *Client) (*Request, error)
  • func (r *Request) Do() (*http.Response, error)
  • func (r *Request) WithCookies(cookies []*http.Cookie) *Request
  • func (r *Request) WithHeader(header http.Header) *Request
  • func (r *Request) WithSecurityScheme(securityScheme auth.SecurityScheme) *Request

Variables

var DefaultClient = NewClient(NewClientOptions{})

Types

type Client

type Client struct {
	*http.Client
	Header  http.Header
	Cookies []*http.Cookie
}

func NewClient

func NewClient(opts NewClientOptions) *Client

func (*Client) WithCookies

func (c *Client) WithCookies(cookies []*http.Cookie) *Client

func (*Client) WithHeader

func (c *Client) WithHeader(header http.Header) *Client

type NewClientOptions

type NewClientOptions struct {
	Timeout   time.Duration
	RateLimit int // requests per second
	ProxyURL  *url.URL

	Header  http.Header
	Cookies []*http.Cookie
}

type Operation

type Operation struct {
	*Client `json:"-" yaml:"-"`

	Method          string                `json:"method" yaml:"method"`
	URL             url.URL               `json:"url,string" yaml:"url,string"`
	Body            *bytes.Buffer         `json:"body,omitempty" yaml:"body,omitempty"`
	Cookies         []*http.Cookie        `json:"cookies,omitempty" yaml:"cookies,omitempty"`
	Header          http.Header           `json:"header,omitempty" yaml:"header,omitempty"`
	SecuritySchemes []auth.SecurityScheme `json:"security_schemes" yaml:"security_schemes"`

	ID   string   `json:"id" yaml:"id"`
	Tags []string `json:"tags,omitempty" yaml:"tags,omitempty"`
}

func NewOperation

func NewOperation(method string, operationUrl string, body *bytes.Buffer, client *Client) (*Operation, error)

func NewOperationFromRequest

func NewOperationFromRequest(r *Request) *Operation

func (*Operation) Clone

func (o *Operation) Clone() *Operation

func (*Operation) GetID

func (operation *Operation) GetID() string

func (*Operation) GetPath

func (operation *Operation) GetPath() string

func (*Operation) GetSecuritySchemes

func (operation *Operation) GetSecuritySchemes() []auth.SecurityScheme

func (*Operation) GetTags

func (operation *Operation) GetTags() []string

func (*Operation) IsReachable

func (operation *Operation) IsReachable() error

func (*Operation) NewRequest

func (operation *Operation) NewRequest() (*Request, error)

func (*Operation) SetID

func (operation *Operation) SetID(id string) *Operation

func (*Operation) SetSecuritySchemes

func (operation *Operation) SetSecuritySchemes(securitySchemes []auth.SecurityScheme) *Operation

func (*Operation) SetTags

func (operation *Operation) SetTags(tags []string) *Operation

func (*Operation) WithCookies

func (operation *Operation) WithCookies(cookies []*http.Cookie) *Operation

func (*Operation) WithHeader

func (operation *Operation) WithHeader(header http.Header) *Operation

func (*Operation) WithOpenapiOperation

func (operation *Operation) WithOpenapiOperation(openapiOperation openapi3.Operation) *Operation

type Operations

type Operations []*Operation

func (Operations) Len

func (o Operations) Len() int

func (Operations) Less

func (o Operations) Less(i, j int) bool

func (Operations) Swap

func (o Operations) Swap(i, j int)

type Request

type Request struct {
	*Client
	*http.Request
}

func NewRequest

func NewRequest(method string, reqUrl string, body io.Reader, client *Client) (*Request, error)

func (*Request) Do

func (r *Request) Do() (*http.Response, error)

func (*Request) WithCookies

func (r *Request) WithCookies(cookies []*http.Cookie) *Request

func (*Request) WithHeader

func (r *Request) WithHeader(header http.Header) *Request

func (*Request) WithSecurityScheme

func (r *Request) WithSecurityScheme(securityScheme auth.SecurityScheme) *Request