Documentation

Overview

    Package api provides primitives to interact the openapi HTTP API.

    Code generated by github.com/algobolson/oapi-codegen DO NOT EDIT.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func AddPetCtx

    func AddPetCtx(next http.Handler) http.Handler

      AddPet operation middleware

      func DeletePetCtx

      func DeletePetCtx(next http.Handler) http.Handler

        DeletePet operation middleware

        func FindPetByIdCtx

        func FindPetByIdCtx(next http.Handler) http.Handler

          FindPetById operation middleware

          func FindPetsCtx

          func FindPetsCtx(next http.Handler) http.Handler

            FindPets operation middleware

            func GetSwagger

            func GetSwagger() (*openapi3.Swagger, error)

              GetSwagger returns the Swagger specification corresponding to the generated code in this file.

              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.

                  Types

                  type AddPetJSONBody

                  type AddPetJSONBody NewPet

                    AddPetJSONBody defines parameters for AddPet.

                    type AddPetJSONRequestBody

                    type AddPetJSONRequestBody AddPetJSONBody

                      AddPetRequestBody defines body for AddPet for application/json ContentType.

                      type Error

                      type Error struct {
                      
                      	// Error code
                      	Code int32 `json:"code"`
                      
                      	// Error message
                      	Message string `json:"message"`
                      }

                        Error defines model for Error.

                        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.

                          func ParamsForFindPets

                          func ParamsForFindPets(ctx context.Context) *FindPetsParams

                            ParamsForFindPets operation parameters from context

                            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
                              
                              	// Unique id of the pet
                              	Id int64 `json:"id"`
                              }

                                Pet defines model for Pet.

                                type PetStore

                                type PetStore struct {
                                	Pets   map[int64]Pet
                                	NextId int64
                                	Lock   sync.Mutex
                                }

                                func NewPetStore

                                func NewPetStore() *PetStore

                                func (*PetStore) AddPet

                                func (p *PetStore) AddPet(w http.ResponseWriter, r *http.Request)

                                func (*PetStore) DeletePet

                                func (p *PetStore) DeletePet(w http.ResponseWriter, r *http.Request)

                                func (*PetStore) FindPetById

                                func (p *PetStore) FindPetById(w http.ResponseWriter, r *http.Request)

                                func (*PetStore) FindPets

                                func (p *PetStore) FindPets(w http.ResponseWriter, r *http.Request)

                                  Here, we implement all of the handlers in the ServerInterface

                                  type ServerInterface

                                  type ServerInterface interface {
                                  	// Returns all pets (GET /pets)
                                  	FindPets(w http.ResponseWriter, r *http.Request)
                                  	// Creates a new pet (POST /pets)
                                  	AddPet(w http.ResponseWriter, r *http.Request)
                                  	// Deletes a pet by ID (DELETE /pets/{id})
                                  	DeletePet(w http.ResponseWriter, r *http.Request)
                                  	// Returns a pet by ID (GET /pets/{id})
                                  	FindPetById(w http.ResponseWriter, r *http.Request)
                                  }