Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package issue1087 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version (devel) DO NOT EDIT.
Index ¶
- func Handler(si ServerInterface) http.Handler
 - func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
 - func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
 - func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
 - func NewGetThingsRequest(server string) (*http.Request, error)
 - type ChiServerOptions
 - type Client
 - type ClientInterface
 - type ClientOption
 - type ClientWithResponses
 - type ClientWithResponsesInterface
 - type GetThingsResponse
 - type HttpRequestDoer
 - type InvalidParamFormatError
 - type MiddlewareFunc
 - type N404
 - type RequestEditorFn
 - type RequiredHeaderError
 - type RequiredParamError
 - type ServerInterface
 - type ServerInterfaceWrapper
 - type Thing
 - type ThingList
 - type ThingResponse
 - type TooManyValuesForParamError
 - type UnescapedCookieParamError
 - type Unimplemented
 - type UnmarshalingParamError
 
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerFromMuxWithBaseURL ¶
func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type ChiServerOptions ¶
type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
    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.
type ClientInterface ¶
type ClientInterface interface {
	// GetThings request
	GetThings(ctx context.Context, 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) GetThingsWithResponse ¶
func (c *ClientWithResponses) GetThingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetThingsResponse, error)
GetThingsWithResponse request returning *GetThingsResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
	// GetThingsWithResponse request
	GetThingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetThingsResponse, error)
}
    ClientWithResponsesInterface is the interface specification for the client with responses above.
type GetThingsResponse ¶
type GetThingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ThingResponse
	JSON401      *externalRef0.N401
	JSON403      *externalRef0.N403
	JSON404      *N404
	JSON500      *externalRef0.DefaultError
}
    func ParseGetThingsResponse ¶
func ParseGetThingsResponse(rsp *http.Response) (*GetThingsResponse, error)
ParseGetThingsResponse parses an HTTP response from a GetThingsWithResponse call
func (GetThingsResponse) Status ¶
func (r GetThingsResponse) Status() string
Status returns HTTPResponse.Status
func (GetThingsResponse) StatusCode ¶
func (r GetThingsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
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 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 {
	// list things
	// (GET /api/my/path)
	GetThings(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) GetThings ¶
func (siw *ServerInterfaceWrapper) GetThings(w http.ResponseWriter, r *http.Request)
GetThings operation middleware
type Thing ¶
type Thing struct {
	// Name just a name
	Name string `json:"name"`
}
    Thing defines model for Thing.
type ThingList ¶
type ThingList struct {
	Keys []Thing `json:"keys"`
}
    ThingList Object containing list of Things
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 Unimplemented ¶
type Unimplemented struct{}
    func (Unimplemented) GetThings ¶
func (_ Unimplemented) GetThings(w http.ResponseWriter, r *http.Request)
list things (GET /api/my/path)
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error