Documentation
¶
Index ¶
- type APIKeyAuthIn
- type APIKeyAuthOpt
- type APIKeyAuthOption
- type BodyLocator
- type BuildOption
- type Client
- func (c *Client) Create(ctx context.Context, path string, body interface{}, opt CreateOption) (*resty.Response, error)
- func (c *Client) Delete(ctx context.Context, path string, opt DeleteOption) (*resty.Response, error)
- func (c *Client) Operation(ctx context.Context, path string, body interface{}, opt OperationOption) (*resty.Response, error)
- func (c *Client) Read(ctx context.Context, path string, opt ReadOption) (*resty.Response, error)
- func (c *Client) Update(ctx context.Context, path string, body interface{}, opt UpdateOption) (*resty.Response, error)
- type CodeLocator
- type CreateOption
- type DeleteOption
- type ExactLocator
- type HTTPBasicOption
- type HTTPTokenOption
- type Header
- type HeaderLocator
- type OAuth2AuthStyle
- type OAuth2ClientCredentialOption
- type OAuth2PasswordOption
- type OAuth2RefreshTokenOption
- type OperationOption
- type PollOption
- type Pollable
- type PollingStatus
- type Query
- type ReadOption
- type UpdateOption
- type ValueLocator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIKeyAuthIn ¶
type APIKeyAuthIn string
const ( APIKeyAuthInHeader APIKeyAuthIn = "header" APIKeyAuthInQuery APIKeyAuthIn = "query" APIKeyAuthInCookie APIKeyAuthIn = "cookie" )
type APIKeyAuthOpt ¶
type APIKeyAuthOpt struct { Name string In APIKeyAuthIn Value string }
type APIKeyAuthOption ¶
type APIKeyAuthOption []APIKeyAuthOpt
type BodyLocator ¶
type BodyLocator string
func (BodyLocator) LocateValueInResp ¶ added in v0.8.0
func (loc BodyLocator) LocateValueInResp(resp resty.Response) string
func (BodyLocator) String ¶
func (loc BodyLocator) String() string
type BuildOption ¶
type BuildOption struct { Security securityOption CookieEnabled bool }
type Client ¶
type Client struct {
*resty.Client
}
type CodeLocator ¶
type CodeLocator struct{}
func (CodeLocator) LocateValueInResp ¶ added in v0.8.0
func (loc CodeLocator) LocateValueInResp(resp resty.Response) string
func (CodeLocator) String ¶
func (loc CodeLocator) String() string
type CreateOption ¶
type DeleteOption ¶
type DeleteOption struct { Method string Query Query Header Header PollOpt *PollOption }
type ExactLocator ¶ added in v0.4.0
type ExactLocator string
func (ExactLocator) LocateValueInResp ¶ added in v0.8.0
func (loc ExactLocator) LocateValueInResp(_ resty.Response) string
func (ExactLocator) String ¶ added in v0.4.0
func (loc ExactLocator) String() string
type HTTPBasicOption ¶ added in v0.7.0
type HTTPTokenOption ¶ added in v0.7.0
type HeaderLocator ¶
type HeaderLocator string
func (HeaderLocator) LocateValueInResp ¶ added in v0.8.0
func (loc HeaderLocator) LocateValueInResp(resp resty.Response) string
func (HeaderLocator) String ¶
func (loc HeaderLocator) String() string
type OAuth2AuthStyle ¶
type OAuth2AuthStyle string
const ( OAuth2AuthStyleInParams OAuth2AuthStyle = "params" OAuth2AuthStyleInHeader OAuth2AuthStyle = "header" )
type OAuth2PasswordOption ¶
type OAuth2RefreshTokenOption ¶ added in v0.7.0
type OperationOption ¶ added in v0.4.0
type PollOption ¶
type PollOption struct { // StatusLocator indicates where the polling status is located in the response of the polling requests. StatusLocator ValueLocator // Status the status sentinels for polling. Status PollingStatus // UrlLocator configures the how to discover the polling location. // If it is nil, the original request URL is used for polling. UrlLocator ValueLocator Header Header Query Query // DefaultDelay specifies the interval between two pollings. The `Retry-After` in the response header takes higher precedence than this. DefaultDelay time.Duration }
type Pollable ¶
type Pollable struct { InitDelay time.Duration URL string Header Header Query Query Status PollingStatus StatusLocator ValueLocator DefaultDelay time.Duration }
func NewPollable ¶
func NewPollable(opt PollOption) (*Pollable, error)
func NewPollableFromResp ¶ added in v0.7.0
func NewPollableFromResp(resp resty.Response, opt PollOption) (*Pollable, error)
type PollingStatus ¶
type ReadOption ¶
type UpdateOption ¶
type ValueLocator ¶
ValueLocator indicates where a value is located in a HTTP response.
Click to show internal directories.
Click to hide internal directories.