1055373165/gophers-sdk-go

Go API client for gopherssdkgo

HTTP Server that handle cute Gophers.

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: 0.1.0
• Package version: 0.0.4
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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

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

import gopherssdkgo "github.com/smy/gophers-sdk-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 gopherssdkgo.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), gopherssdkgo.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 gopherssdkgo.ContextOperationServerIndices and gopherssdkgo.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Class	Method	HTTP request	Description
GophersAPI	CheckHealth	Get /healthz
GophersAPI	GopherDelete	Delete /gopher
GophersAPI	GopherGet	Get /gopher
GophersAPI	GopherPost	Post /gopher	Add a new Gopher
GophersAPI	GopherPut	Put /gopher
GophersAPI	GophersGet	Get /gophers

Documentation For Models

• Gopher
• GopherPutRequest

Documentation For Authorization

Endpoints do not require authorization.

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