swagger

README

Go API client for swagger

Actual example use cases for a curated list of golang api generator libraries

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
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

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

import "./swagger"

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	GetError	Get /error	Get an error
DefaultApi	Greeting	Get /greeting/{name}	Say hello to someone
DefaultApi	PostReview	Post /reviews	Send a review

Documentation For Models

• GetGreetingOutputBody
• ModelError
• PostReviewInputBody

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Overview

* Awesome GO API * * Actual example use cases for a curated list of golang api generator libraries * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Awesome GO API * * Actual example use cases for a curated list of golang api generator libraries * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Awesome GO API * * Actual example use cases for a curated list of golang api generator libraries * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Awesome GO API * * Actual example use cases for a curated list of golang api generator libraries * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Awesome GO API * * Actual example use cases for a curated list of golang api generator libraries * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Awesome GO API * * Actual example use cases for a curated list of golang api generator libraries * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Awesome GO API * * Actual example use cases for a curated list of golang api generator libraries * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

• Variables
• func CacheExpires(r *http.Response) time.Time
• type APIClient
  • func NewAPIClient(cfg *Configuration) *APIClient
  • func (c *APIClient) ChangeBasePath(path string)
• type APIKey
• type APIResponse
  • func NewAPIResponse(r *http.Response) *APIResponse
  • func NewAPIResponseWithError(errorMessage string) *APIResponse
• type BasicAuth
• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) AddDefaultHeader(key string, value string)
• type DefaultApiService
  • func (a *DefaultApiService) GetError(ctx context.Context) (*http.Response, error)
  • func (a *DefaultApiService) Greeting(ctx context.Context, name string) (GetGreetingOutputBody, *http.Response, error)
  • func (a *DefaultApiService) PostReview(ctx context.Context, body PostReviewInputBody) (*http.Response, error)
• type GenericSwaggerError
  • func (e GenericSwaggerError) Body() []byte
  • func (e GenericSwaggerError) Error() string
  • func (e GenericSwaggerError) Model() interface{}
• type GetGreetingOutputBody
• type ModelError
• type PostReviewInputBody

Variables

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Awesome GO API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

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

type DefaultApiService

type DefaultApiService service

func (*DefaultApiService) GetError

func (a *DefaultApiService) GetError(ctx context.Context) (*http.Response, error)

DefaultApiService Get an error Responds with an error

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*DefaultApiService) Greeting

func (a *DefaultApiService) Greeting(ctx context.Context, name string) (GetGreetingOutputBody, *http.Response, error)

DefaultApiService Say hello to someone Responds with a greeting

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param name Name to greet

@return GetGreetingOutputBody

func (*DefaultApiService) PostReview

func (a *DefaultApiService) PostReview(ctx context.Context, body PostReviewInputBody) (*http.Response, error)

DefaultApiService Send a review Post a review to be saved

• @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body

type GenericSwaggerError

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetGreetingOutputBody

type GetGreetingOutputBody struct {
	// Greeting message
	Message string `json:"message"`
}

type ModelError

type ModelError struct {
	// A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
	Title string `json:"title"`
	// A human-readable explanation specific to this occurrence of the problem.
	Details string `json:"details,omitempty"`
	// Optional map of properties
	Properties ModelMap `json:"properties,omitempty"`
}

An API error

type PostReviewInputBody

type PostReviewInputBody struct {
	// Author of the review
	Author string `json:"author"`
	// Review message
	Message string `json:"message,omitempty"`
	// Rating from 1 to 5
	Rating int64 `json:"rating"`
}