Documentation
¶
Overview ¶
Package petstore provides primitives to interact with the openapi HTTP API.
Code generated by github.com/cparta/oapi-codegen version (devel) DO NOT EDIT.
Index ¶
- func NewAddPetRequest(server string, body AddPetJSONRequestBody) (*http.Request, error)
- func NewAddPetRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewDeletePetRequest(server string, id int64) (*http.Request, error)
- func NewFindPetByIDRequest(server string, id int64) (*http.Request, error)
- func NewFindPetsRequest(server string, params *FindPetsParams) (*http.Request, error)
- func RegisterHandlers(router gin.IRouter, si ServerInterface) gin.IRouter
- func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions) gin.IRouter
- type AddPetJSONBody
- type AddPetJSONRequestBody
- type AddPetResponse
- type Client
- func (c *Client) AddPet(ctx context.Context, body AddPetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) AddPetWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) DeletePet(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FindPetByID(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FindPets(ctx context.Context, params *FindPetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) AddPetWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*AddPetResponse, error)
- func (c *ClientWithResponses) AddPetWithResponse(ctx context.Context, body AddPetJSONRequestBody, reqEditors ...RequestEditorFn) (*AddPetResponse, error)
- func (c *ClientWithResponses) DeletePetWithResponse(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*DeletePetResponse, error)
- func (c *ClientWithResponses) FindPetByIDWithResponse(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*FindPetByIDResponse, error)
- func (c *ClientWithResponses) FindPetsWithResponse(ctx context.Context, params *FindPetsParams, reqEditors ...RequestEditorFn) (*FindPetsResponse, error)
- type ClientWithResponsesInterface
- type DeletePetResponse
- type Error
- type FindPetByIDResponse
- type FindPetsParams
- type FindPetsResponse
- type GinServerOptions
- type HttpRequestDoer
- type MiddlewareFunc
- type NewPet
- type Pet
- type RequestEditorFn
- type ServerInterface
- type ServerInterfaceWrapper
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewAddPetRequest ¶
func NewAddPetRequest(server string, body AddPetJSONRequestBody) (*http.Request, error)
NewAddPetRequest calls the generic AddPet builder with application/json body
func NewAddPetRequestWithBody ¶
func NewAddPetRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewAddPetRequestWithBody generates requests for AddPet with any type of body
func NewDeletePetRequest ¶
NewDeletePetRequest generates requests for DeletePet
func NewFindPetByIDRequest ¶
NewFindPetByIDRequest generates requests for FindPetByID
func NewFindPetsRequest ¶
func NewFindPetsRequest(server string, params *FindPetsParams) (*http.Request, error)
NewFindPetsRequest generates requests for FindPets
func RegisterHandlers ¶ added in v1.9.3
func RegisterHandlers(router gin.IRouter, si ServerInterface) gin.IRouter
RegisterHandlers creates http.Handler with routing matching OpenAPI spec.
func RegisterHandlersWithOptions ¶ added in v1.9.3
func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions) gin.IRouter
RegisterHandlersWithOptions creates http.Handler with additional options
Types ¶
type AddPetJSONRequestBody ¶
type AddPetJSONRequestBody AddPetJSONBody
AddPetJSONRequestBody defines body for AddPet for application/json ContentType.
type AddPetResponse ¶
type AddPetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Pet
JSONDefault *Error
}
func ParseAddPetResponse ¶
func ParseAddPetResponse(rsp *http.Response) (*AddPetResponse, error)
ParseAddPetResponse parses an HTTP response from a AddPetWithResponse call
func (AddPetResponse) Status ¶
func (r AddPetResponse) Status() string
Status returns HTTPResponse.Status
func (AddPetResponse) StatusCode ¶
func (r AddPetResponse) 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) AddPet ¶
func (c *Client) AddPet(ctx context.Context, body AddPetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) AddPetWithBody ¶
func (*Client) FindPetByID ¶
func (*Client) FindPets ¶
func (c *Client) FindPets(ctx context.Context, params *FindPetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface {
// FindPets request
FindPets(ctx context.Context, params *FindPetsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// AddPet request with any body
AddPetWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
AddPet(ctx context.Context, body AddPetJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeletePet request
DeletePet(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*http.Response, error)
// FindPetByID request
FindPetByID(ctx context.Context, id int64, 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) AddPetWithBodyWithResponse ¶
func (c *ClientWithResponses) AddPetWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddPetResponse, error)
AddPetWithBodyWithResponse request with arbitrary body returning *AddPetResponse
func (*ClientWithResponses) AddPetWithResponse ¶
func (c *ClientWithResponses) AddPetWithResponse(ctx context.Context, body AddPetJSONRequestBody, reqEditors ...RequestEditorFn) (*AddPetResponse, error)
func (*ClientWithResponses) DeletePetWithResponse ¶
func (c *ClientWithResponses) DeletePetWithResponse(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*DeletePetResponse, error)
DeletePetWithResponse request returning *DeletePetResponse
func (*ClientWithResponses) FindPetByIDWithResponse ¶
func (c *ClientWithResponses) FindPetByIDWithResponse(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*FindPetByIDResponse, error)
FindPetByIDWithResponse request returning *FindPetByIDResponse
func (*ClientWithResponses) FindPetsWithResponse ¶
func (c *ClientWithResponses) FindPetsWithResponse(ctx context.Context, params *FindPetsParams, reqEditors ...RequestEditorFn) (*FindPetsResponse, error)
FindPetsWithResponse request returning *FindPetsResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// FindPets request
FindPetsWithResponse(ctx context.Context, params *FindPetsParams, reqEditors ...RequestEditorFn) (*FindPetsResponse, error)
// AddPet request with any body
AddPetWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddPetResponse, error)
AddPetWithResponse(ctx context.Context, body AddPetJSONRequestBody, reqEditors ...RequestEditorFn) (*AddPetResponse, error)
// DeletePet request
DeletePetWithResponse(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*DeletePetResponse, error)
// FindPetByID request
FindPetByIDWithResponse(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*FindPetByIDResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type DeletePetResponse ¶
func ParseDeletePetResponse ¶
func ParseDeletePetResponse(rsp *http.Response) (*DeletePetResponse, error)
ParseDeletePetResponse parses an HTTP response from a DeletePetWithResponse call
func (DeletePetResponse) Status ¶
func (r DeletePetResponse) Status() string
Status returns HTTPResponse.Status
func (DeletePetResponse) StatusCode ¶
func (r DeletePetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Error ¶
type Error struct {
// Error code
Code int32 `json:"code"`
// Error message
Message string `json:"message"`
}
Error defines model for Error.
type FindPetByIDResponse ¶
type FindPetByIDResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Pet
JSONDefault *Error
}
func ParseFindPetByIDResponse ¶
func ParseFindPetByIDResponse(rsp *http.Response) (*FindPetByIDResponse, error)
ParseFindPetByIDResponse parses an HTTP response from a FindPetByIDWithResponse call
func (FindPetByIDResponse) Status ¶
func (r FindPetByIDResponse) Status() string
Status returns HTTPResponse.Status
func (FindPetByIDResponse) StatusCode ¶
func (r FindPetByIDResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FindPetsParams ¶
type FindPetsParams struct {
// tags to filter by
Tags *[]string `json:"tags,omitempty"`
// maximum number of results to return
Limit *int32 `json:"limit,omitempty"`
}
FindPetsParams defines parameters for FindPets.
type FindPetsResponse ¶
type FindPetsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]Pet
JSONDefault *Error
}
func ParseFindPetsResponse ¶
func ParseFindPetsResponse(rsp *http.Response) (*FindPetsResponse, error)
ParseFindPetsResponse parses an HTTP response from a FindPetsWithResponse call
func (FindPetsResponse) Status ¶
func (r FindPetsResponse) Status() string
Status returns HTTPResponse.Status
func (FindPetsResponse) StatusCode ¶
func (r FindPetsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GinServerOptions ¶ added in v1.9.3
type GinServerOptions struct {
BaseURL string
Middlewares []gin.HandlerFunc
}
GinServerOptions provides options for the Gin server.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type MiddlewareFunc ¶ added in v1.9.3
type MiddlewareFunc = gin.HandlerFunc
keeping for backward compatibility
type NewPet ¶
type NewPet struct {
// Name of the pet
Name string `json:"name"`
// Type of the pet
Tag *string `json:"tag,omitempty"`
}
NewPet defines model for NewPet.
type Pet ¶
type Pet struct {
// Embedded struct due to allOf(#/components/schemas/NewPet)
NewPet `yaml:",inline"`
// Embedded fields due to inline allOf schema
// Unique id of the pet
Id int64 `json:"id"`
}
Pet defines model for Pet.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ServerInterface ¶ added in v1.9.3
type ServerInterface interface {
// Returns all pets
// (GET /pets)
FindPets(c *gin.Context, params FindPetsParams)
// Creates a new pet
// (POST /pets)
AddPet(c *gin.Context)
// Deletes a pet by ID
// (DELETE /pets/{id})
DeletePet(c *gin.Context, id int64)
// Returns a pet by ID
// (GET /pets/{id})
FindPetByID(c *gin.Context, id int64)
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶ added in v1.9.3
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) AddPet ¶ added in v1.9.3
func (siw *ServerInterfaceWrapper) AddPet(c *gin.Context)
AddPet operation middleware
func (*ServerInterfaceWrapper) DeletePet ¶ added in v1.9.3
func (siw *ServerInterfaceWrapper) DeletePet(c *gin.Context)
DeletePet operation middleware
func (*ServerInterfaceWrapper) FindPetByID ¶ added in v1.9.3
func (siw *ServerInterfaceWrapper) FindPetByID(c *gin.Context)
FindPetByID operation middleware
func (*ServerInterfaceWrapper) FindPets ¶ added in v1.9.3
func (siw *ServerInterfaceWrapper) FindPets(c *gin.Context)
FindPets operation middleware