Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.0.0-00010101000000-000000000000 DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (swagger *openapi3.T, err error)
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, m *http.ServeMux) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, m *http.ServeMux, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler
- func NewAddThingRequest(server string, body AddThingJSONRequestBody) (*http.Request, error)
- func NewAddThingRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewListThingsRequest(server string) (*http.Request, error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type AddThingJSONRequestBody
- type AddThingResponse
- type Client
- func (c *Client) AddThing(ctx context.Context, body AddThingJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) AddThingWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) ListThings(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) AddThingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*AddThingResponse, error)
- func (c *ClientWithResponses) AddThingWithResponse(ctx context.Context, body AddThingJSONRequestBody, ...) (*AddThingResponse, error)
- func (c *ClientWithResponses) ListThingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListThingsResponse, error)
- type ClientWithResponsesInterface
- type Error
- type HttpRequestDoer
- type InvalidParamFormatError
- type ListThingsResponse
- type MiddlewareFunc
- type RequestEditorFn
- type RequiredHeaderError
- type RequiredParamError
- type ServerInterface
- type ServerInterfaceWrapper
- type StdHTTPServerOptions
- type Thing
- type ThingWithID
- type TooManyValuesForParamError
- type UnescapedCookieParamError
- type UnmarshalingParamError
Constants ¶
const (
BearerAuthScopes = "BearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
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 Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, m *http.ServeMux) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
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 ¶
NewListThingsRequest generates requests for ListThings
Types ¶
type AddThingJSONRequestBody ¶
type AddThingJSONRequestBody = Thing
AddThingJSONRequestBody defines body for AddThing for application/json ContentType.
type AddThingResponse ¶
type AddThingResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *[]ThingWithID
}
func ParseAddThingResponse ¶
func ParseAddThingResponse(rsp *http.Response) (*AddThingResponse, error)
ParseAddThingResponse parses an HTTP response from a AddThingWithResponse call
func (AddThingResponse) Status ¶
func (r AddThingResponse) Status() string
Status returns HTTPResponse.Status
func (AddThingResponse) StatusCode ¶
func (r AddThingResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
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 (*Client) ListThings ¶
type ClientInterface ¶
type ClientInterface interface {
// ListThings request
ListThings(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// AddThingWithBody 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 ClientOption ¶
ClientOption allows setting custom parameters during construction
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) (*AddThingResponse, error)
AddThingWithBodyWithResponse request with arbitrary body returning *AddThingResponse
func (*ClientWithResponses) AddThingWithResponse ¶
func (c *ClientWithResponses) AddThingWithResponse(ctx context.Context, body AddThingJSONRequestBody, reqEditors ...RequestEditorFn) (*AddThingResponse, error)
func (*ClientWithResponses) ListThingsWithResponse ¶
func (c *ClientWithResponses) ListThingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListThingsResponse, error)
ListThingsWithResponse request returning *ListThingsResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// ListThingsWithResponse request
ListThingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListThingsResponse, error)
// AddThingWithBodyWithResponse request with any body
AddThingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddThingResponse, error)
AddThingWithResponse(ctx context.Context, body AddThingJSONRequestBody, reqEditors ...RequestEditorFn) (*AddThingResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
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 HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type ListThingsResponse ¶
type ListThingsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]ThingWithID
}
func ParseListThingsResponse ¶
func ParseListThingsResponse(rsp *http.Response) (*ListThingsResponse, error)
ParseListThingsResponse parses an HTTP response from a ListThingsWithResponse call
func (ListThingsResponse) Status ¶
func (r ListThingsResponse) Status() string
Status returns HTTPResponse.Status
func (ListThingsResponse) StatusCode ¶
func (r ListThingsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type RequiredHeaderError ¶
func (*RequiredHeaderError) Error ¶
func (e *RequiredHeaderError) Error() string
func (*RequiredHeaderError) Unwrap ¶
func (e *RequiredHeaderError) Unwrap() error
type RequiredParamError ¶
type RequiredParamError struct {
ParamName string
}
func (*RequiredParamError) Error ¶
func (e *RequiredParamError) Error() string
type ServerInterface ¶
type ServerInterface interface {
// (GET /things)
ListThings(w http.ResponseWriter, r *http.Request)
// (POST /things)
AddThing(w http.ResponseWriter, r *http.Request)
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) AddThing ¶
func (siw *ServerInterfaceWrapper) AddThing(w http.ResponseWriter, r *http.Request)
AddThing operation middleware
func (*ServerInterfaceWrapper) ListThings ¶
func (siw *ServerInterfaceWrapper) ListThings(w http.ResponseWriter, r *http.Request)
ListThings operation middleware
type StdHTTPServerOptions ¶
type StdHTTPServerOptions struct {
BaseURL string
BaseRouter *http.ServeMux
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type ThingWithID ¶
ThingWithID defines model for ThingWithID.
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error