pkg1

Documentation

Overview

Package pkg1 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/jKiler/oapi-codegen version v1.0.0-00010101000000-000000000000 DO NOT EDIT.

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func NewTestGetRequest(server string) (*http.Request, error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• func RegisterHandlers(router EchoRouter, si ServerInterface)
• func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) TestGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
• type ClientInterface
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(doer HttpRequestDoer) ClientOption
  • func WithRequestEditorFn(fn RequestEditorFn) ClientOption
• type ClientWithResponses
  • func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
  • func (c *ClientWithResponses) TestGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*TestGetResponse, error)
• type ClientWithResponsesInterface
• type EchoRouter
• type HttpRequestDoer
• type RequestEditorFn
• type ServerInterface
  • func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) TestGet(ctx echo.Context) error
• type StrictHandlerFunc
• type StrictMiddlewareFunc
• type StrictServerInterface
• type TestGet200Response
  • func (response TestGet200Response) VisitTestGetResponse(w http.ResponseWriter) error
• type TestGetRequestObject
• type TestGetResponse
  • func ParseTestGetResponse(rsp *http.Response) (*TestGetResponse, error)
  • func (r TestGetResponse) Status() string
  • func (r TestGetResponse) StatusCode() int
• type TestGetResponseObject

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func NewTestGetRequest

func NewTestGetRequest(server string) (*http.Request, error)

NewTestGetRequest generates requests for TestGet

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func RegisterHandlers

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

Types

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) TestGet

func (c *Client) TestGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// TestGet request
	TestGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

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

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) TestGetWithResponse

func (c *ClientWithResponses) TestGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*TestGetResponse, error)

TestGetWithResponse request returning *TestGetResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// TestGetWithResponse request
	TestGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*TestGetResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type EchoRouter

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ServerInterface

type ServerInterface interface {
	// get test response
	// (GET /test)
	TestGet(ctx echo.Context) error
}

ServerInterface represents all server handlers.

func NewStrictHandler

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) TestGet

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

TestGet converts echo context to params.

type StrictHandlerFunc

type StrictHandlerFunc = strictecho.StrictEchoHandlerFunc

type StrictMiddlewareFunc

type StrictMiddlewareFunc = strictecho.StrictEchoMiddlewareFunc

type StrictServerInterface

type StrictServerInterface interface {
	// get test response
	// (GET /test)
	TestGet(ctx context.Context, request TestGetRequestObject) (TestGetResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TestGet200Response

type TestGet200Response externalRef0.ResponseWithReferenceResponse

func (TestGet200Response) VisitTestGetResponse

func (response TestGet200Response) VisitTestGetResponse(w http.ResponseWriter) error

type TestGetRequestObject

type TestGetRequestObject struct {
}

type TestGetResponse

type TestGetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseTestGetResponse

func ParseTestGetResponse(rsp *http.Response) (*TestGetResponse, error)

ParseTestGetResponse parses an HTTP response from a TestGetWithResponse call

func (TestGetResponse) Status

func (r TestGetResponse) Status() string

Status returns HTTPResponse.Status

func (TestGetResponse) StatusCode

func (r TestGetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TestGetResponseObject

type TestGetResponseObject interface {
	VisitTestGetResponse(w http.ResponseWriter) error
}