inline

Documentation

Overview

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

Code generated by github.com/lzurbriggen/oapi-codegen version (devel) DO NOT EDIT.

Index

• Constants
• func NewGetPetsRequest(server string) (*http.Request, error)
• func RegisterHandlers(router EchoRouter, si ServerInterface)
• func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
• type Cat
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) GetPets(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) GetPetsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetPetsResponse, error)
• type ClientWithResponsesInterface
• type Dog
• type EchoRouter
• type GetPetsResponse
  • func ParseGetPetsResponse(rsp *http.Response) (*GetPetsResponse, error)
  • func (r GetPetsResponse) Status() string
  • func (r GetPetsResponse) StatusCode() int
• type GetPets_200_Data_Item
• type HttpRequestDoer
• type Rat
• type RequestEditorFn
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) GetPets(ctx echo.Context) error

Constants

const (
	ApiKeyAuthScopes = "ApiKeyAuth.Scopes"
)

Functions

func NewGetPetsRequest

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

NewGetPetsRequest generates requests for GetPets

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 Cat

type Cat struct {
	Breed *string `json:"breed,omitempty"`
	Color *string `json:"color,omitempty"`
	Id    *string `json:"id,omitempty"`
	Name  *string `json:"name,omitempty"`
	Purrs *bool   `json:"purrs,omitempty"`
}

Cat This is a cat

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

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

type ClientInterface

type ClientInterface interface {
	// GetPets request
	GetPets(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) GetPetsWithResponse

func (c *ClientWithResponses) GetPetsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetPetsResponse, error)

GetPetsWithResponse request returning *GetPetsResponse

type ClientWithResponsesInterface

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

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

type Dog

type Dog struct {
	Barks *bool   `json:"barks,omitempty"`
	Breed *string `json:"breed,omitempty"`
	Color *string `json:"color,omitempty"`
	Id    *string `json:"id,omitempty"`
	Name  *string `json:"name,omitempty"`
}

Dog This is a dog

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 GetPetsResponse

type GetPetsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *[]GetPets_200_Data_Item `json:"data,omitempty"`
	}
}

func ParseGetPetsResponse

func ParseGetPetsResponse(rsp *http.Response) (*GetPetsResponse, error)

ParseGetPetsResponse parses an HTTP response from a GetPetsWithResponse call

func (GetPetsResponse) Status

func (r GetPetsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPetsResponse) StatusCode

func (r GetPetsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPets_200_Data_Item

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

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Rat

type Rat struct {
	Color   *string `json:"color,omitempty"`
	Id      *string `json:"id,omitempty"`
	Name    *string `json:"name,omitempty"`
	Squeaks *bool   `json:"squeaks,omitempty"`
}

Rat This is a rat

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 a list of pets
	// (GET /pets)
	GetPets(ctx echo.Context) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) GetPets

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

GetPets converts echo context to params.