client

package

v0.0.0-...-6c4fc3a Latest Latest Go to latest Published: Nov 22, 2017 License: Apache-2.0 Imports: 25 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/lilymona/runtime

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func APIKeyAuth(name, in, value string) runtime.ClientAuthInfoWriter
func BasicAuth(username, password string) runtime.ClientAuthInfoWriter
func BearerToken(token string) runtime.ClientAuthInfoWriter
func TLSClient(opts TLSClientOptions) (*http.Client, error)
func TLSClientAuth(opts TLSClientOptions) (*tls.Config, error)
func TLSTransport(opts TLSClientOptions) (http.RoundTripper, error)
type Runtime
- func New(host, basePath string, schemes []string) *Runtime
- func NewWithClient(host, basePath string, schemes []string, client *http.Client) *Runtime
type TLSClientOptions

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultTimeout = 30 * time.Second

DefaultTimeout the default request timeout

View Source

var PassThroughAuth runtime.ClientAuthInfoWriter

PassThroughAuth never manipulates the request

Functions ¶

func APIKeyAuth ¶

func APIKeyAuth(name, in, value string) runtime.ClientAuthInfoWriter

APIKeyAuth provides an API key auth info writer

func BasicAuth ¶

func BasicAuth(username, password string) runtime.ClientAuthInfoWriter

BasicAuth provides a basic auth info writer

func BearerToken ¶

func BearerToken(token string) runtime.ClientAuthInfoWriter

BearerToken provides a header based oauth2 bearer access token auth info writer

func TLSClient ¶

func TLSClient(opts TLSClientOptions) (*http.Client, error)

TLSClient creates a http.Client for mutual auth

func TLSClientAuth ¶

func TLSClientAuth(opts TLSClientOptions) (*tls.Config, error)

TLSClientAuth creates a tls.Config for mutual auth

func TLSTransport ¶

func TLSTransport(opts TLSClientOptions) (http.RoundTripper, error)

TLSTransport creates a http client transport suitable for mutual tls auth

Types ¶

type Runtime ¶

type Runtime struct {
	DefaultMediaType      string
	DefaultAuthentication runtime.ClientAuthInfoWriter
	Consumers             map[string]runtime.Consumer
	Producers             map[string]runtime.Producer

	Transport http.RoundTripper
	Jar       http.CookieJar
	//Spec      *spec.Document
	Host     string
	BasePath string
	Formats  strfmt.Registry
	Context  context.Context

	Debug bool
	// contains filtered or unexported fields
}

Runtime represents an API client that uses the transport to make http requests based on a swagger specification.

func New ¶

func New(host, basePath string, schemes []string) *Runtime

New creates a new default runtime for a swagger api runtime.Client

func NewWithClient ¶

func NewWithClient(host, basePath string, schemes []string, client *http.Client) *Runtime

NewWithClient allows you to create a new transport with a configured http.Client

func (*Runtime) SetDebug ¶

func (r *Runtime) SetDebug(debug bool)

SetDebug changes the debug flag. It ensures that client and middlewares have the set debug level.

func (*Runtime) SetLogger ¶

func (r *Runtime) SetLogger(logger logger.Logger)

SetLogger changes the logger stream. It ensures that client and middlewares use the same logger.

func (*Runtime) Submit ¶

func (r *Runtime) Submit(operation *runtime.ClientOperation) (interface{}, error)

Submit a request and when there is a body on success it will turn that into the result all other things are turned into an api error for swagger which retains the status code

type TLSClientOptions ¶

type TLSClientOptions struct {
	Certificate        string
	Key                string
	CA                 string
	ServerName         string
	InsecureSkipVerify bool
	// contains filtered or unexported fields
}

TLSClientOptions to configure client authentication with mutual TLS

Source Files ¶

View all Source files

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