api

package
v2.1.21 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 15, 2022 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

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

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

Index

Constants

View Source 
const (
	BearerAuthScopes = "BearerAuth.Scopes"
)

Variables

This section is empty.

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 NewAddThingRequest 

func NewAddThingRequest(server string, body AddThingJSONRequestBody) (*http.Request, error)

NewAddThingRequest calls the generic AddThing builder with application/json body

func NewAddThingRequestWithBody 

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

NewAddThingRequestWithBody generates requests for AddThing with any type of body

func NewListThingsRequest 

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

NewListThingsRequest generates requests for ListThings

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, m ...echo.MiddlewareFunc)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL 

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string, m ...echo.MiddlewareFunc)

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

Types

type AddThingJSONBody 

type AddThingJSONBody = Thing

AddThingJSONBody defines parameters for AddThing.

type AddThingJSONRequestBody 

type AddThingJSONRequestBody = AddThingJSONBody

AddThingJSONRequestBody defines body for AddThing for application/json ContentType.

type AddThingResponse 

type AddThingResponse struct {
	Code    int
	JSON201 *ThingWithID
}

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

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

func (*Client) AddThingWithBody 

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

func (*Client) ListThings 

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

type ClientAddThingResponse 

type ClientAddThingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *ThingWithID
}

func ParseAddThingResponse 

func ParseAddThingResponse(rsp *http.Response) (*ClientAddThingResponse, error)

ParseAddThingResponse parses an HTTP response from a AddThingWithResponse call

func (ClientAddThingResponse) RawResponse added in v2.1.17 

func (r ClientAddThingResponse) RawResponse() *http.Response

RawResponse returns pointer to the raw http.Response

func (ClientAddThingResponse) ResponseBody added in v2.0.8 

func (r ClientAddThingResponse) ResponseBody() []byte

ResponseBody returns HTTPResponse.Body as byte array

func (ClientAddThingResponse) Status 

func (r ClientAddThingResponse) Status() string

Status returns HTTPResponse.Status

func (ClientAddThingResponse) StatusCode 

func (r ClientAddThingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ClientInterface 

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

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

	AddThing(ctx context.Context, body AddThingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientListThingsResponse 

type ClientListThingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      []ThingWithID
}

func ParseListThingsResponse 

func ParseListThingsResponse(rsp *http.Response) (*ClientListThingsResponse, error)

ParseListThingsResponse parses an HTTP response from a ListThingsWithResponse call

func (ClientListThingsResponse) RawResponse added in v2.1.17 

func (r ClientListThingsResponse) RawResponse() *http.Response

RawResponse returns pointer to the raw http.Response

func (ClientListThingsResponse) ResponseBody added in v2.0.8 

func (r ClientListThingsResponse) ResponseBody() []byte

ResponseBody returns HTTPResponse.Body as byte array

func (ClientListThingsResponse) Status 

func (r ClientListThingsResponse) Status() string

Status returns HTTPResponse.Status

func (ClientListThingsResponse) StatusCode 

func (r ClientListThingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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

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

AddThingWithBodyWithResponse request with arbitrary body returning *AddThingResponse

func (*ClientWithResponses) AddThingWithResponse 

func (c *ClientWithResponses) AddThingWithResponse(ctx context.Context, body AddThingJSONRequestBody, reqEditors ...RequestEditorFn) (*ClientAddThingResponse, error)

func (*ClientWithResponses) ListThingsWithResponse 

func (c *ClientWithResponses) ListThingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ClientListThingsResponse, error)

ListThingsWithResponse request returning *ListThingsResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// ListThings request
	ListThingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ClientListThingsResponse, error)

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

	AddThingWithResponse(ctx context.Context, body AddThingJSONRequestBody, reqEditors ...RequestEditorFn) (*ClientAddThingResponse, 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 {
	// Error code
	Code int32 `json:"code" validate:"required"`

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

Error defines model for Error.

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ListThingsResponse 

type ListThingsResponse struct {
	Code    int
	JSON200 []ThingWithID
}

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 /things)
	ListThings(ctx echo.Context) (resp *ListThingsResponse, err error)

	// (POST /things)
	AddThing(ctx echo.Context, requestBody AddThingJSONBody) (resp *AddThingResponse, err error)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) AddThing 

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

AddThing converts echo context to params.

func (*ServerInterfaceWrapper) ListThings 

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

ListThings converts echo context to params.

type Thing 

type Thing struct {
	Name string `json:"name" validate:"required"`
}

Thing defines model for Thing.

type ThingWithID 

type ThingWithID struct {
	Id   int64  `json:"id" validate:"required"`
	Name string `json:"name" validate:"required"`
}

ThingWithID defines model for ThingWithID.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.