issue312

Documentation

Overview

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

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

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func NewGetPetRequest(server string, petId string) (*http.Request, error)
• func NewValidatePetsRequest(server string, body ValidatePetsJSONRequestBody) (*http.Request, error)
• func NewValidatePetsRequestWithBody(server 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 Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) GetPet(ctx context.Context, petId string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) ValidatePets(ctx context.Context, body ValidatePetsJSONRequestBody, ...) (*http.Response, error)
  • func (c *Client) ValidatePetsWithBody(ctx context.Context, 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) GetPetWithResponse(ctx context.Context, petId string, reqEditors ...RequestEditorFn) (*GetPetResponse, error)
  • func (c *ClientWithResponses) ValidatePetsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*ValidatePetsResponse, error)
  • func (c *ClientWithResponses) ValidatePetsWithResponse(ctx context.Context, body ValidatePetsJSONRequestBody, ...) (*ValidatePetsResponse, error)
• type ClientWithResponsesInterface
• type EchoRouter
• type Error
• type GetPetResponse
  • func ParseGetPetResponse(rsp *http.Response) (*GetPetResponse, error)
  • func (r GetPetResponse) Status() string
  • func (r GetPetResponse) StatusCode() int
• type HttpRequestDoer
• type Pet
• type PetNames
• type RequestEditorFn
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) GetPet(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) ValidatePets(ctx echo.Context) error
• type ValidatePetsJSONRequestBody
• type ValidatePetsResponse
  • func ParseValidatePetsResponse(rsp *http.Response) (*ValidatePetsResponse, error)
  • func (r ValidatePetsResponse) Status() string
  • func (r ValidatePetsResponse) StatusCode() int

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 NewGetPetRequest

func NewGetPetRequest(server string, petId string) (*http.Request, error)

NewGetPetRequest generates requests for GetPet

func NewValidatePetsRequest

func NewValidatePetsRequest(server string, body ValidatePetsJSONRequestBody) (*http.Request, error)

NewValidatePetsRequest calls the generic ValidatePets builder with application/json body

func NewValidatePetsRequestWithBody

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

NewValidatePetsRequestWithBody generates requests for ValidatePets 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 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) GetPet

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

func (*Client) ValidatePets

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

func (*Client) ValidatePetsWithBody

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

type ClientInterface

type ClientInterface interface {
	// GetPet request
	GetPet(ctx context.Context, petId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ValidatePetsWithBody request with any body
	ValidatePetsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ValidatePets(ctx context.Context, body ValidatePetsJSONRequestBody, 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) GetPetWithResponse

func (c *ClientWithResponses) GetPetWithResponse(ctx context.Context, petId string, reqEditors ...RequestEditorFn) (*GetPetResponse, error)

GetPetWithResponse request returning *GetPetResponse

func (*ClientWithResponses) ValidatePetsWithBodyWithResponse

func (c *ClientWithResponses) ValidatePetsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ValidatePetsResponse, error)

ValidatePetsWithBodyWithResponse request with arbitrary body returning *ValidatePetsResponse

func (*ClientWithResponses) ValidatePetsWithResponse

func (c *ClientWithResponses) ValidatePetsWithResponse(ctx context.Context, body ValidatePetsJSONRequestBody, reqEditors ...RequestEditorFn) (*ValidatePetsResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetPetWithResponse request
	GetPetWithResponse(ctx context.Context, petId string, reqEditors ...RequestEditorFn) (*GetPetResponse, error)

	// ValidatePetsWithBodyWithResponse request with any body
	ValidatePetsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ValidatePetsResponse, error)

	ValidatePetsWithResponse(ctx context.Context, body ValidatePetsJSONRequestBody, reqEditors ...RequestEditorFn) (*ValidatePetsResponse, 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 Error

type Error struct {
	// Code Error code
	Code int32 `json:"code"`

	// Message Error message
	Message string `json:"message"`
}

Error defines model for Error.

type GetPetResponse

type GetPetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Pet
}

func ParseGetPetResponse

func ParseGetPetResponse(rsp *http.Response) (*GetPetResponse, error)

ParseGetPetResponse parses an HTTP response from a GetPetWithResponse call

func (GetPetResponse) Status

func (r GetPetResponse) Status() string

Status returns HTTPResponse.Status

func (GetPetResponse) StatusCode

func (r GetPetResponse) 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 Pet

type Pet struct {
	// Name The name of the pet.
	Name string `json:"name"`
}

Pet defines model for Pet.

type PetNames

type PetNames struct {
	// Names The names of the pets.
	Names []string `json:"names"`
}

PetNames defines model for PetNames.

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 pet given identifier.
	// (GET /pets/{petId})
	GetPet(ctx echo.Context, petId string) error
	// Validate pets
	// (POST /pets:validate)
	ValidatePets(ctx echo.Context) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) GetPet

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

GetPet converts echo context to params.

func (*ServerInterfaceWrapper) ValidatePets

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

ValidatePets converts echo context to params.

type ValidatePetsJSONRequestBody

type ValidatePetsJSONRequestBody = PetNames

ValidatePetsJSONRequestBody defines body for ValidatePets for application/json ContentType.

type ValidatePetsResponse

type ValidatePetsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Pet
	JSONDefault  *Error
}

func ParseValidatePetsResponse

func ParseValidatePetsResponse(rsp *http.Response) (*ValidatePetsResponse, error)

ParseValidatePetsResponse parses an HTTP response from a ValidatePetsWithResponse call

func (ValidatePetsResponse) Status

func (r ValidatePetsResponse) Status() string

Status returns HTTPResponse.Status

func (ValidatePetsResponse) StatusCode

func (r ValidatePetsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode