Documentation
¶
Overview ¶
Package petstore provides primitives to interact the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen 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 ParseaddPetResponse(rsp *http.Response) (*addPetResponse, error)
- func ParsedeletePetResponse(rsp *http.Response) (*deletePetResponse, error)
- func ParsefindPetByIdResponse(rsp *http.Response) (*findPetByIdResponse, error)
- func ParsefindPetsResponse(rsp *http.Response) (*findPetsResponse, error)
- type AddPetJSONRequestBody
- type Client
- func (c *Client) AddPet(ctx context.Context, body AddPetJSONRequestBody) (*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) (*http.Response, error)
- func (c *Client) FindPetById(ctx context.Context, id int64) (*http.Response, error)
- func (c *Client) FindPets(ctx context.Context, params *FindPetsParams) (*http.Response, error)
- type ClientInterface
- 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) (*addPetResponse, error)
- func (c *ClientWithResponses) DeletePetWithResponse(ctx context.Context, id int64) (*deletePetResponse, error)
- func (c *ClientWithResponses) FindPetByIdWithResponse(ctx context.Context, id int64) (*findPetByIdResponse, error)
- func (c *ClientWithResponses) FindPetsWithResponse(ctx context.Context, params *FindPetsParams) (*findPetsResponse, error)
- type Error
- type FindPetsParams
- type NewPet
- type Pet
- type RequestEditorFn
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 ParseaddPetResponse ¶
ParseaddPetResponse parses an HTTP response from a AddPetWithResponse call
func ParsedeletePetResponse ¶
ParsedeletePetResponse parses an HTTP response from a DeletePetWithResponse call
func ParsefindPetByIdResponse ¶
ParsefindPetByIdResponse parses an HTTP response from a FindPetByIdWithResponse call
func ParsefindPetsResponse ¶
ParsefindPetsResponse parses an HTTP response from a FindPetsWithResponse call
Types ¶
type AddPetJSONRequestBody ¶
type AddPetJSONRequestBody addPetJSONBody
AddPetRequestBody defines body for AddPet for application/json ContentType.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example.
Server string
// HTTP client with any customized settings, such as certificate chains.
Client http.Client
// A callback for modifying requests which are generated before sending over
// the network.
RequestEditor RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func (*Client) AddPetWithBody ¶
func (*Client) FindPetById ¶
type ClientInterface ¶
type ClientInterface interface {
// FindPets request
FindPets(ctx context.Context, params *FindPetsParams) (*http.Response, error)
// AddPet request with any body
AddPetWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)
AddPet(ctx context.Context, body AddPetJSONRequestBody) (*http.Response, error)
// DeletePet request
DeletePet(ctx context.Context, id int64) (*http.Response, error)
// FindPetById request
FindPetById(ctx context.Context, id int64) (*http.Response, error)
}
The interface specification for the client above.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string) *ClientWithResponses
NewClientWithResponses returns a ClientWithResponses with a default Client:
func NewClientWithResponsesAndRequestEditorFunc ¶
func NewClientWithResponsesAndRequestEditorFunc(server string, reqEditorFn RequestEditorFn) *ClientWithResponses
NewClientWithResponsesAndRequestEditorFunc takes in a RequestEditorFn callback function and returns a ClientWithResponses with a default Client:
func (*ClientWithResponses) AddPetWithBodyWithResponse ¶
func (c *ClientWithResponses) AddPetWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*addPetResponse, error)
AddPetWithBodyWithResponse request with arbitrary body returning *AddPetResponse
func (*ClientWithResponses) AddPetWithResponse ¶
func (c *ClientWithResponses) AddPetWithResponse(ctx context.Context, body AddPetJSONRequestBody) (*addPetResponse, error)
func (*ClientWithResponses) DeletePetWithResponse ¶
func (c *ClientWithResponses) DeletePetWithResponse(ctx context.Context, id int64) (*deletePetResponse, error)
DeletePetWithResponse request returning *DeletePetResponse
func (*ClientWithResponses) FindPetByIdWithResponse ¶
func (c *ClientWithResponses) FindPetByIdWithResponse(ctx context.Context, id int64) (*findPetByIdResponse, error)
FindPetByIdWithResponse request returning *FindPetByIdResponse
func (*ClientWithResponses) FindPetsWithResponse ¶
func (c *ClientWithResponses) FindPetsWithResponse(ctx context.Context, params *FindPetsParams) (*findPetsResponse, error)
FindPetsWithResponse request returning *FindPetsResponse
type FindPetsParams ¶
type FindPetsParams struct {
Tags *[]string `json:"tags,omitempty"`
Limit *int32 `json:"limit,omitempty"`
}
FindPetsParams defines parameters for FindPets.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
Package api provides primitives to interact the openapi HTTP API.
|
Package api provides primitives to interact the openapi HTTP API. |
|
This is an example of implementing the Pet Store from the OpenAPI documentation found at: https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml The code under api/petstore/ has been generated from that specification.
|
This is an example of implementing the Pet Store from the OpenAPI documentation found at: https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml The code under api/petstore/ has been generated from that specification. |
|
api
Package api provides primitives to interact the openapi HTTP API.
|
Package api provides primitives to interact the openapi HTTP API. |