api

Documentation

Overview

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

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

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func NewGetCacheRequest(server string, key string) (*http.Request, error)
• func NewPostCacheRequest(server string, key string, body PostCacheJSONRequestBody) (*http.Request, error)
• func NewPostCacheRequestWithBody(server string, key string, contentType string, body io.Reader) (*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 API
  • func NewAPI(e EchoRouter, db store.IStore) *API
  • func (a *API) GetCache(ctx echo.Context, key string) error
  • func (a *API) PostCache(ctx echo.Context, key string) error
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) GetCache(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) PostCache(ctx context.Context, key string, body PostCacheJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) PostCacheWithBody(ctx context.Context, key string, contentType string, body io.Reader, ...) (*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) GetCacheWithResponse(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*GetCacheResponse, error)
  • func (c *ClientWithResponses) PostCacheWithBodyWithResponse(ctx context.Context, key string, contentType string, body io.Reader, ...) (*PostCacheResponse, error)
  • func (c *ClientWithResponses) PostCacheWithResponse(ctx context.Context, key string, body PostCacheJSONRequestBody, ...) (*PostCacheResponse, error)
• type ClientWithResponsesInterface
• type EchoRouter
• type GetCacheResponse
  • func ParseGetCacheResponse(rsp *http.Response) (*GetCacheResponse, error)
  • func (r GetCacheResponse) Status() string
  • func (r GetCacheResponse) StatusCode() int
• type HttpRequestDoer
• type PostCacheJSONBody
• type PostCacheJSONRequestBody
• type PostCacheResponse
  • func ParsePostCacheResponse(rsp *http.Response) (*PostCacheResponse, error)
  • func (r PostCacheResponse) Status() string
  • func (r PostCacheResponse) StatusCode() int
• type RequestEditorFn
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) GetCache(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) PostCache(ctx echo.Context) error

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 NewGetCacheRequest

func NewGetCacheRequest(server string, key string) (*http.Request, error)

NewGetCacheRequest generates requests for GetCache

func NewPostCacheRequest

func NewPostCacheRequest(server string, key string, body PostCacheJSONRequestBody) (*http.Request, error)

NewPostCacheRequest calls the generic PostCache builder with application/json body

func NewPostCacheRequestWithBody

func NewPostCacheRequestWithBody(server string, key string, contentType string, body io.Reader) (*http.Request, error)

NewPostCacheRequestWithBody generates requests for PostCache with any type of body

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 API

type API struct {
	// contains filtered or unexported fields
}

func NewAPI

func NewAPI(e EchoRouter, db store.IStore) *API

func (*API) GetCache

func (a *API) GetCache(ctx echo.Context, key string) error

GetCache implements ServerInterface

func (*API) PostCache

func (a *API) PostCache(ctx echo.Context, key string) error

PostCache implements ServerInterface

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) GetCache

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

func (*Client) PostCache

func (c *Client) PostCache(ctx context.Context, key string, body PostCacheJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostCacheWithBody

func (c *Client) PostCacheWithBody(ctx context.Context, key string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// PostCache request with any body
	PostCacheWithBody(ctx context.Context, key string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostCache(ctx context.Context, key string, body PostCacheJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCache request
	GetCache(ctx context.Context, key string, 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) GetCacheWithResponse

func (c *ClientWithResponses) GetCacheWithResponse(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*GetCacheResponse, error)

GetCacheWithResponse request returning *GetCacheResponse

func (*ClientWithResponses) PostCacheWithBodyWithResponse

func (c *ClientWithResponses) PostCacheWithBodyWithResponse(ctx context.Context, key string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCacheResponse, error)

PostCacheWithBodyWithResponse request with arbitrary body returning *PostCacheResponse

func (*ClientWithResponses) PostCacheWithResponse

func (c *ClientWithResponses) PostCacheWithResponse(ctx context.Context, key string, body PostCacheJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCacheResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// PostCache request with any body
	PostCacheWithBodyWithResponse(ctx context.Context, key string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCacheResponse, error)

	PostCacheWithResponse(ctx context.Context, key string, body PostCacheJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCacheResponse, error)

	// GetCache request
	GetCacheWithResponse(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*GetCacheResponse, 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 GetCacheResponse

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

func ParseGetCacheResponse

func ParseGetCacheResponse(rsp *http.Response) (*GetCacheResponse, error)

ParseGetCacheResponse parses an HTTP response from a GetCacheWithResponse call

func (GetCacheResponse) Status

func (r GetCacheResponse) Status() string

Status returns HTTPResponse.Status

func (GetCacheResponse) StatusCode

func (r GetCacheResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type PostCacheJSONBody

type PostCacheJSONBody = map[string]interface{}

PostCacheJSONBody defines parameters for PostCache.

type PostCacheJSONRequestBody

type PostCacheJSONRequestBody = PostCacheJSONBody

PostCacheJSONRequestBody defines body for PostCache for application/json ContentType.

type PostCacheResponse

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

func ParsePostCacheResponse

func ParsePostCacheResponse(rsp *http.Response) (*PostCacheResponse, error)

ParsePostCacheResponse parses an HTTP response from a PostCacheWithResponse call

func (PostCacheResponse) Status

func (r PostCacheResponse) Status() string

Status returns HTTPResponse.Status

func (PostCacheResponse) StatusCode

func (r PostCacheResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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 {

	// (POST /admin/cache/{key})
	PostCache(ctx echo.Context, key string) error

	// (GET /cache/{key})
	GetCache(ctx echo.Context, key string) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) GetCache

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

GetCache converts echo context to params.

func (*ServerInterfaceWrapper) PostCache

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

PostCache converts echo context to params.