client

Documentation

Index

• Constants
• Variables
• type APIClient
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *APIClient
  • func NewHTTPClient(formats strfmt.Registry) *APIClient
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *APIClient
  • func (c *APIClient) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "localhost"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/api/v1"
)

Variables

var Default = NewHTTPClient(nil)

Default API client HTTP client.

var DefaultSchemes = []string{"https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type APIClient

type APIClient struct {
	Announcement *announcement.Client

	APIKey *api_key.Client

	Chat *chat.Client

	Execution *execution.Client

	Funding *funding.Client

	Instrument *instrument.Client

	Insurance *insurance.Client

	Leaderboard *leaderboard.Client

	Liquidation *liquidation.Client

	Notification *notification.Client

	Order *order.Client

	OrderBook *order_book.Client

	Position *position.Client

	Quote *quote.Client

	Schema *schema.Client

	Settlement *settlement.Client

	Stats *stats.Client

	Trade *trade.Client

	User *user.Client

	Transport runtime.ClientTransport
}

APIClient is a client for API client

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *APIClient

New creates a new API client client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *APIClient

NewHTTPClient creates a new API client HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *APIClient

NewHTTPClientWithConfig creates a new API client HTTP client, using a customizable transport config.

func (*APIClient) SetTransport

func (c *APIClient) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.