swagger

README

Go API client for swagger

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \ *_/ ' " =end

Overview

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

• API version: 1.0.0 *_/ ' " =end \r\n \n \r
• Package version: 1.0.0
• Build date: 2016-07-12T18:49:24.937+08:00
• Build package: class io.swagger.codegen.languages.GoClientCodegen

Installation

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

    "./swagger"

Documentation for API Endpoints

All URIs are relative to *https://petstore.swagger.io / ' " =end \r\n \n \r/v2 */ ' " =end \r\n \n \r

Class	Method	HTTP request	Description
FakeApi	TestCodeInjectEndRnNR	Put /fake	To test code injection *_/ ' " =end \r\n \n \r

Documentation For Models

• ModelReturn

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: api_key */ ' " =end \r\n \n \r
• Location: HTTP header

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorizatoin URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
• write:pets: modify pets in your account */ ' " =end \r\n \n \r
• read:pets: read your pets */ ' " =end \r\n \n \r

Author

apiteam@swagger.io *_/ ' " =end \r\n \n \r

Documentation

Index

• type APIClient
  • func (c *APIClient) CallAPI(path string, method string, postBody interface{}, ...) (*resty.Response, error)
  • func (c *APIClient) ParameterToString(obj interface{}, collectionFormat string) string
  • func (c *APIClient) SelectHeaderAccept(accepts []string) string
  • func (c *APIClient) SelectHeaderContentType(contentTypes []string) string
• type APIResponse
  • func NewAPIResponse(r *http.Response) *APIResponse
  • func NewAPIResponseWithError(errorMessage string) *APIResponse
• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) AddDefaultHeader(key string, value string)
  • func (c *Configuration) GetAPIKeyWithPrefix(APIKeyIdentifier string) string
  • func (c *Configuration) GetBasicAuthEncodedString() string
  • func (c *Configuration) GetDebug() bool
  • func (c *Configuration) SetDebug(enable bool)
• type FakeApi
  • func NewFakeApi() *FakeApi
  • func NewFakeApiWithBasePath(basePath string) *FakeApi
  • func (a FakeApi) TestCodeInjectEndRnNR(testCodeInjectEndRnNR string) (*APIResponse, error)
• type ModelReturn

Types

type APIClient

type APIClient struct {
}

func (*APIClient) CallAPI

func (c *APIClient) CallAPI(path string, method string,
	postBody interface{},
	headerParams map[string]string,
	queryParams url.Values,
	formParams map[string]string,
	fileName string,
	fileBytes []byte) (*resty.Response, error)

func (*APIClient) ParameterToString

func (c *APIClient) ParameterToString(obj interface{}, collectionFormat string) string

func (*APIClient) SelectHeaderAccept

func (c *APIClient) SelectHeaderAccept(accepts []string) string

func (*APIClient) SelectHeaderContentType

func (c *APIClient) SelectHeaderContentType(contentTypes []string) string

type APIResponse

type APIResponse struct {
	*http.Response
	Message string `json:"message,omitempty"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Configuration

type Configuration struct {
	UserName     string            `json:"userName,omitempty"`
	Password     string            `json:"password,omitempty"`
	APIKeyPrefix map[string]string `json:"APIKeyPrefix,omitempty"`
	APIKey       map[string]string `json:"APIKey,omitempty"`

	DebugFile     string            `json:"debugFile,omitempty"`
	OAuthToken    string            `json:"oAuthToken,omitempty"`
	Timeout       int               `json:"timeout,omitempty"`
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	AccessToken   string            `json:"accessToken,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	APIClient     APIClient         `json:"APIClient,omitempty"`
	// contains filtered or unexported fields
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

func (*Configuration) GetAPIKeyWithPrefix

func (c *Configuration) GetAPIKeyWithPrefix(APIKeyIdentifier string) string

func (*Configuration) GetBasicAuthEncodedString

func (c *Configuration) GetBasicAuthEncodedString() string

func (*Configuration) GetDebug

func (c *Configuration) GetDebug() bool

func (*Configuration) SetDebug

func (c *Configuration) SetDebug(enable bool)

type FakeApi

type FakeApi struct {
	Configuration Configuration
}

func NewFakeApi

func NewFakeApi() *FakeApi

func NewFakeApiWithBasePath

func NewFakeApiWithBasePath(basePath string) *FakeApi

func (FakeApi) TestCodeInjectEndRnNR

func (a FakeApi) TestCodeInjectEndRnNR(testCodeInjectEndRnNR string) (*APIResponse, error)

*

• To test code injection *_/ ' \" =end \\r\\n \\n \\r *
• @param testCodeInjectEndRnNR To test code injection *_/ ' \" =end \\r\\n \\n \\r
• @return void

type ModelReturn

type ModelReturn struct {

	// property description  *_/ ' \" =end \\r\\n \\n \\r
	Return_ int32 `json:"return,omitempty"`
}

Model for testing reserved words *_/ ' \" =end \\r\\n \\n \\r