openapi_go

README

OPENAPI GO 接口

Documentation

Index

• Constants
• type Client
  • func NewClient(cred *credential.Credential, options ...Option) (c *Client, err error)
  • func (c *Client) GetBaseUrl() string
  • func (c *Client) PrintSign(rb *xhttp.RequestBuilder)
  • func (c *Client) SetBaseUrl(baseURL string)
  • func (c *Client) SetCredential(cred *credential.Credential) error
  • func (c *Client) SetProxy(proxy string) error
  • func (c *Client) SetTimeout(timeout time.Duration)
• type Option
  • func WithBaseURL(baseURL string) Option
  • func WithProxy(proxy string) Option
  • func WithRetryCondition(retryCondition func(resp *http.Response, err error) bool) Option
  • func WithRetryInterval(retryInterval time.Duration) Option
  • func WithRetryTimes(retryTimes int) Option
  • func WithTimeout(timeout time.Duration) Option

Constants

const (
	// header
	V1Header = "X-Ys-Version"
	V1Value  = "2023-05-30"
	// DefaultBaseURL defaults gateway for Open-API
	DefaultBaseURL = "http://localhost:8899/"
)

Types

type Client

type Client struct {
	*apiv1.API
	// contains filtered or unexported fields
}

Client represents the Open-API client

func NewClient

func NewClient(cred *credential.Credential, options ...Option) (c *Client, err error)

NewClient creates new client for Open-YS

func (*Client) GetBaseUrl

func (c *Client) GetBaseUrl() string

func (*Client) PrintSign

func (c *Client) PrintSign(rb *xhttp.RequestBuilder)

func (*Client) SetBaseUrl

func (c *Client) SetBaseUrl(baseURL string)

func (*Client) SetCredential

func (c *Client) SetCredential(cred *credential.Credential) error

func (*Client) SetProxy

func (c *Client) SetProxy(proxy string) error

func (*Client) SetTimeout

func (c *Client) SetTimeout(timeout time.Duration)

type Option

type Option func(c *Client) error

func WithBaseURL

func WithBaseURL(baseURL string) Option

func WithProxy

func WithProxy(proxy string) Option

func WithRetryCondition

func WithRetryCondition(retryCondition func(resp *http.Response, err error) bool) Option

func WithRetryInterval

func WithRetryInterval(retryInterval time.Duration) Option

func WithRetryTimes

func WithRetryTimes(retryTimes int) Option

func WithTimeout

func WithTimeout(timeout time.Duration) Option