bai-lu / openapi-petstore-go

Go API client for openapi

This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/bai-lu/openapi-petstore-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class	Method	HTTP request	Description
PetAPI	AddPet	Post /pet	Add a new pet to the store
PetAPI	DeletePet	Delete /pet/{petId}	Deletes a pet
PetAPI	FindPetsByStatus	Get /pet/findByStatus	Finds Pets by status
PetAPI	FindPetsByTags	Get /pet/findByTags	Finds Pets by tags
PetAPI	GetPetById	Get /pet/{petId}	Find pet by ID
PetAPI	UpdatePet	Put /pet	Update an existing pet
PetAPI	UpdatePetWithForm	Post /pet/{petId}	Updates a pet in the store with form data
PetAPI	UploadFile	Post /pet/{petId}/uploadImage	uploads an image
StoreAPI	DeleteOrder	Delete /store/order/{orderId}	Delete purchase order by ID
StoreAPI	GetInventory	Get /store/inventory	Returns pet inventories by status
StoreAPI	GetOrderById	Get /store/order/{orderId}	Find purchase order by ID
StoreAPI	PlaceOrder	Post /store/order	Place an order for a pet
UserAPI	CreateUser	Post /user	Create user
UserAPI	CreateUsersWithArrayInput	Post /user/createWithArray	Creates list of users with given input array
UserAPI	CreateUsersWithListInput	Post /user/createWithList	Creates list of users with given input array
UserAPI	DeleteUser	Delete /user/{username}	Delete user
UserAPI	GetUserByName	Get /user/{username}	Get user by user name
UserAPI	LoginUser	Get /user/login	Logs user into the system
UserAPI	LogoutUser	Get /user/logout	Logs out current logged in user session
UserAPI	UpdateUser	Put /user/{username}	Updated user

Documentation For Models

• ApiResponse
• Category
• Order
• Pet
• Tag
• User

Documentation For Authorization

Authentication schemes defined for the API:

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
• write:pets: modify pets in your account
• read:pets: read your pets

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: api_key and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"api_key": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author