bkapi

package

Go to main page

Versions in this module

v0

v0.1.16

Nov 7, 2022

Changes in this version

+ var ErrClientConfigRegistryValidationFailed = fmt.Errorf("client config validation failed")

type ClientConfig

+ BkApiUrlTmpl string

+ ClientOptions []define.BkApiClientOption

+ func (c *ClientConfig) GetClientOptions() []define.BkApiClientOption

+ type ClientConfigRegistry struct

+ func GetGlobalClientConfigRegistry() *ClientConfigRegistry

+ func NewClientConfigRegistry() *ClientConfigRegistry

+ func (r *ClientConfigRegistry) ProvideConfig(apiName string) define.ClientConfig

+ func (r *ClientConfigRegistry) RegisterClientConfig(apiName string, provider define.ClientConfigProvider) error

+ func (r *ClientConfigRegistry) RegisterDefaultConfig(provider define.ClientConfigProvider) error

v0.1.15

Oct 28, 2022

Changes in this version

+ func RegisterGlobalBkapiClientOption(opt define.BkApiClientOption)

v0.1.14

Oct 26, 2022

v0.1.13

Jul 28, 2022

v0.1.12

Jul 14, 2022

v0.1.11

Jul 14, 2022

v0.1.10

May 18, 2022

Changes in this version

+ func OptErrorCallback(fn func(err error) error) define.BkapiOption

+ func OptRequestCallback(fn func(request *http.Request) *http.Request) define.BkapiOption

+ func OptResponseCallback(fn func(response *http.Response) *http.Response) define.BkapiOption

v0.1.9

May 17, 2022

Changes in this version

+ func OptAddRequestQueryParamList(key string, values []string) define.BkapiOption

v0.1.8

May 16, 2022

v0.1.7

May 6, 2022

v0.1.6

Apr 27, 2022

v0.1.5

Apr 21, 2022

Changes in this version

+ func NewBkApiClient(apiName string, configProvider define.ClientConfigProvider, ...) (define.BkApiClient, error)

+ func OptAddCookie(cookie *http.Cookie) define.BkapiOption

+ func OptAddRequestQueryParam(key string, value string) define.BkapiOption

+ func OptBasicAuth(username, password string) define.BkapiOption

+ func OptBearerAuth(token string) define.BkapiOption

+ func OptDelAllCookies() define.BkapiOption

+ func OptDelRequestHeader(key string) define.BkapiOption

+ func OptDelRequestQueryParam(key string) define.BkapiOption

+ func OptDialTimeout(duration, keepAlive time.Duration) define.BkapiOption

+ func OptLimitRedirect(limit int) define.BkapiOption

+ func OptProxies(servers map[string]string) define.BkapiOption

+ func OptSetRequestBody(data interface{}) define.OperationOption

+ func OptSetRequestHeader(key string, value string) define.BkapiOption

+ func OptSetRequestHeaders(header map[string]string) define.BkapiOption

+ func OptSetRequestPathParams(params map[string]string) define.OperationOption

+ func OptSetRequestQueryParam(key string, value string) define.BkapiOption

+ func OptSetRequestQueryParams(params map[string]string) define.BkapiOption

+ func OptSetRequestResult(result interface{}) define.OperationOption

+ func OptTLS(config *tls.Config) define.BkapiOption

+ func OptTLShandshakeTimeout(duration time.Duration) define.BkapiOption

+ func OptTimeout(duration time.Duration) define.BkapiOption

+ func OptTransport(roundTripper http.RoundTripper) define.BkapiOption

+ type ClientConfig struct

+ AccessToken string

+ AppCode string

+ AppSecret string

+ AuthorizationJWT string

+ AuthorizationParams map[string]string

+ Endpoint string

+ Getenv func(string) string

+ JsonMarshaler func(v interface{}) ([]byte, error)

+ Logger logging.Logger

+ Stage string

+ func (c *ClientConfig) GetAuthorizationHeaders() map[string]string

+ func (c *ClientConfig) GetLogger() logging.Logger

+ func (c *ClientConfig) GetName() string

+ func (c *ClientConfig) GetUrl() string

+ func (c ClientConfig) ProvideConfig(apiName string) define.ClientConfig

+ type FormMarshalBodyProvider struct

+ func FormBodyProvider() *FormMarshalBodyProvider

+ func NewFormMarshalBodyProvider(marshaler func(v interface{}) ([]byte, error)) *FormMarshalBodyProvider

+ func OptFormBodyProvider() *FormMarshalBodyProvider

+ type FunctionalBodyProvider struct

+ func NewFunctionalBodyProvider(fn func(operation define.Operation, data interface{}) error) *FunctionalBodyProvider

+ func (p *FunctionalBodyProvider) ApplyToClient(cli define.BkApiClient) error

+ func (p *FunctionalBodyProvider) ApplyToOperation(op define.Operation) error

+ func (p *FunctionalBodyProvider) ProvideBody(operation define.Operation, data interface{}) error

+ type JsonMarshalBodyProvider struct

+ func JsonBodyProvider() *JsonMarshalBodyProvider

+ func NewJsonMarshalBodyProvider(marshaler func(v interface{}) ([]byte, error)) *JsonMarshalBodyProvider

+ func OptJsonBodyProvider() *JsonMarshalBodyProvider

+ type JsonUnmarshalResultProvider struct

+ func JsonResultProvider() *JsonUnmarshalResultProvider

+ func NewJsonUnmarshalResultProvider(unmarshaler func(body io.Reader, v interface{}) error) *JsonUnmarshalResultProvider

+ func OptJsonResultProvider() *JsonUnmarshalResultProvider

+ type MarshalBodyProvider struct

+ func NewMarshalBodyProvider(contentType string, marshalFn func(v interface{}) ([]byte, error)) *MarshalBodyProvider

+ func (m *MarshalBodyProvider) ApplyToClient(cli define.BkApiClient) error

+ func (m *MarshalBodyProvider) ApplyToOperation(op define.Operation) error

+ func (m *MarshalBodyProvider) ContentType() string

+ func (m *MarshalBodyProvider) ProvideBody(operation define.Operation, data interface{}) error

+ type MultipartFormFieldsBodyProvider struct

+ func MultipartFormBodyProvider() *MultipartFormFieldsBodyProvider

+ func NewMultipartFormFieldsBodyProvider() *MultipartFormFieldsBodyProvider

+ func OptMultipartFormBodyProvider() *MultipartFormFieldsBodyProvider

+ type OperationConfig struct

+ Method string

+ Name string

+ Path string

+ func (c *OperationConfig) GetMethod() string

+ func (c *OperationConfig) GetName() string

+ func (c *OperationConfig) GetPath() string

+ func (c OperationConfig) ProvideConfig() define.OperationConfig

+ type OperationOption struct

+ func NewOperationOption(fn func(operation define.Operation) error) *OperationOption

+ func (o *OperationOption) ApplyToClient(client define.BkApiClient) error

+ func (o *OperationOption) ApplyToOperation(op define.Operation) error

+ type UnmarshalResultProvider struct

+ func NewUnmarshalResultProvider(fn func(body io.Reader, v interface{}) error) *UnmarshalResultProvider

+ func (p *UnmarshalResultProvider) ApplyToClient(cli define.BkApiClient) error

+ func (p *UnmarshalResultProvider) ApplyToOperation(op define.Operation) error

+ func (p *UnmarshalResultProvider) ProvideResult(response *http.Response, result interface{}) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL