Back to godoc.org

Package schemas

v1.9.2
Latest Go to latest

The highest tagged major version is .

Published: Oct 22, 2019 | License: Apache-2.0 | Module: github.com/devk-insurance/oapi-codegen

Overview

Package schemas provides primitives to interact the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.

Index

func GetSwagger

func GetSwagger() (*openapi3.Swagger, error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file.

func NewIssue30Request

func NewIssue30Request(server string, pFallthrough string) (*http.Request, error)

NewIssue30Request generates requests for Issue30

func NewIssue41Request

func NewIssue41Request(server string, n1param N5StartsWithNumber) (*http.Request, error)

NewIssue41Request generates requests for Issue41

func NewIssue9Request

func NewIssue9Request(server string, params *Issue9Params, body Issue9JSONRequestBody) (*http.Request, error)

NewIssue9Request calls the generic Issue9 builder with application/json body

func NewIssue9RequestWithBody

func NewIssue9RequestWithBody(server string, params *Issue9Params, contentType string, body io.Reader) (*http.Request, error)

NewIssue9RequestWithBody generates requests for Issue9 with any type of body

func Parseissue30Response

func Parseissue30Response(rsp *http.Response) (*issue30Response, error)

Parseissue30Response parses an HTTP response from a Issue30WithResponse call

func Parseissue41Response

func Parseissue41Response(rsp *http.Response) (*issue41Response, error)

Parseissue41Response parses an HTTP response from a Issue41WithResponse call

func Parseissue9Response

func Parseissue9Response(rsp *http.Response) (*issue9Response, error)

Parseissue9Response parses an HTTP response from a Issue9WithResponse call

func RegisterHandlers

func RegisterHandlers(router runtime.EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

type AnyType1

type AnyType1 interface{}

AnyType1 defines model for AnyType1.

type AnyType2

type AnyType2 interface{}

AnyType2 defines model for AnyType2.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example.
	Server string

	// HTTP client with any customized settings, such as certificate chains.
	Client *http.Client

	// A callback for modifying requests which are generated before sending over
	// the network.
	RequestEditor RequestEditorFn

	// A callback which gets called after request finished, before any
	// deserialization steps.
	RequestCompletion RequestCompletionFn

	// List of additional interceptors, which gets called prior
	// of the RequestEditor.
	Interceptors []Interceptor
	// contains filtered or unexported fields
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(ctx context.Context, opts ...Option) (*Client, error)

NewClient creates a new Client.

func (*Client) Intercept

func (c *Client) Intercept(req *http.Request, ctx context.Context) error

Intercept intercepts the request, applies all registered Interceptors which are part of the client. If an Interceptor fails, the Interceptor chain will return early.

func (*Client) Issue30

func (c *Client) Issue30(ctx context.Context, pFallthrough string) (*http.Response, error)

func (*Client) Issue41

func (c *Client) Issue41(ctx context.Context, n1param N5StartsWithNumber) (*http.Response, error)

func (*Client) Issue9

func (c *Client) Issue9(ctx context.Context, params *Issue9Params, body Issue9JSONRequestBody) (*http.Response, error)

func (*Client) Issue9WithBody

func (c *Client) Issue9WithBody(ctx context.Context, params *Issue9Params, contentType string, body io.Reader) (*http.Response, error)

type ClientInterface

type ClientInterface interface {

	// Intercept intercepts the request, applies all registered Interceptors
	// which are part of the client.
	// If an Interceptor fails, the Interceptor chain will return early.
	Intercept(req *http.Request, ctx context.Context) error

	// Issue30 request
	Issue30(ctx context.Context, pFallthrough string) (*http.Response, error)

	// Issue41 request
	Issue41(ctx context.Context, n1param N5StartsWithNumber) (*http.Response, error)

	// Issue9 request  with any body
	Issue9WithBody(ctx context.Context, params *Issue9Params, contentType string, body io.Reader) (*http.Response, error)

	Issue9(ctx context.Context, params *Issue9Params, body Issue9JSONRequestBody) (*http.Response, error)
}

The interface specification for the client above.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string) *ClientWithResponses

NewClientWithResponses returns a ClientWithResponses with a default Client:

func NewClientWithResponsesAndRequestEditorFunc

func NewClientWithResponsesAndRequestEditorFunc(server string, reqEditorFn RequestEditorFn) *ClientWithResponses

NewClientWithResponsesAndRequestEditorFunc takes in a RequestEditorFn callback function and returns a ClientWithResponses with a default Client:

func (*ClientWithResponses) Issue30WithResponse

func (c *ClientWithResponses) Issue30WithResponse(ctx context.Context, pFallthrough string) (*issue30Response, error)

Issue30WithResponse request returning *Issue30Response

func (*ClientWithResponses) Issue41WithResponse

func (c *ClientWithResponses) Issue41WithResponse(ctx context.Context, n1param N5StartsWithNumber) (*issue41Response, error)

Issue41WithResponse request returning *Issue41Response

func (*ClientWithResponses) Issue9WithBodyWithResponse

func (c *ClientWithResponses) Issue9WithBodyWithResponse(ctx context.Context, params *Issue9Params, contentType string, body io.Reader) (*issue9Response, error)

Issue9WithBodyWithResponse request with arbitrary body returning *Issue9Response

func (*ClientWithResponses) Issue9WithResponse

func (c *ClientWithResponses) Issue9WithResponse(ctx context.Context, params *Issue9Params, body Issue9JSONRequestBody) (*issue9Response, error)

type CustomStringType

type CustomStringType string

CustomStringType defines model for CustomStringType.

type GenericObject

type GenericObject map[string]interface{}

GenericObject defines model for GenericObject.

type Interceptor

type Interceptor interface {
	// Intercept intercepts a request and can fail with an error.
	Intercept(req *http.Request, ctx context.Context) error
}

Interceptor allows intercepting requests.

type InterceptorFn

type InterceptorFn func(req *http.Request, ctx context.Context) error

InterceptorFn allows intercepting requests and can be used as an adapter to a Interceptor.

func (InterceptorFn) Intercept

func (f InterceptorFn) Intercept(req *http.Request, ctx context.Context) error

InterceptorFn is an adapter to allow the use of ordinary functions as Interceptors.

type Issue9JSONBody

type Issue9JSONBody interface{}

Issue9JSONBody defines parameters for Issue9.

type Issue9JSONRequestBody

type Issue9JSONRequestBody Issue9JSONBody

Issue9RequestBody defines body for Issue9 for application/json ContentType.

type Issue9Params

type Issue9Params struct {
	Foo string `json:"foo"`
}

Issue9Params defines parameters for Issue9.

type N5StartsWithNumber

type N5StartsWithNumber map[string]interface{}

N5StartsWithNumber defines model for 5StartsWithNumber.

type Option

type Option func(*Client) error

Option allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) Option

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient allows overriding the default httpClient, which is automatically created. This is useful for tests.

func WithIdleTimeout

func WithIdleTimeout(timeout time.Duration) Option

WithIdleTimeout overrides the timeout of idle connections.

func WithInterceptors

func WithInterceptors(interceptors ...Interceptor) Option

WithInterceptors allows adding 0..N interceptors, which get called in serial order prior of calling the RequestEditor before finally making the request. Use this function to attach authentication mechanisms.

func WithMaxIdleConnections

func WithMaxIdleConnections(maxIdleConns uint) Option

WithMaxIdleConnections overrides the amount of idle connections of the underlying http-client.

func WithRequestCompletionFn

func WithRequestCompletionFn(fn RequestCompletionFn) Option

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) Option

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithRequestTimeout

func WithRequestTimeout(timeout time.Duration) Option

WithRequestTimeout overrides the timeout of individual requests.

func WithUserAgent

func WithUserAgent(userAgent string) Option

WithUserAgent allows setting the userAgent

type RequestCompletionFn

type RequestCompletionFn func(req *http.Request, resp *http.Response)

RequestCompletionFn is the function signature for the RequestCompletion callback function

type RequestEditorFn

type RequestEditorFn func(req *http.Request, ctx context.Context) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ServerInterface

type ServerInterface interface {
	// (GET /issues/30/{fallthrough})
	Issue30(ctx echo.Context, pFallthrough string) error
	// (GET /issues/41/{1param})
	Issue41(ctx echo.Context, n1param N5StartsWithNumber) error
	// (GET /issues/9)
	Issue9(ctx echo.Context, params Issue9Params) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) Issue30

func (w *ServerInterfaceWrapper) Issue30(ctx echo.Context) error

Issue30 converts echo context to params.

func (*ServerInterfaceWrapper) Issue41

func (w *ServerInterfaceWrapper) Issue41(ctx echo.Context) error

Issue41 converts echo context to params.

func (*ServerInterfaceWrapper) Issue9

func (w *ServerInterfaceWrapper) Issue9(ctx echo.Context) error

Issue9 converts echo context to params.

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier