todoclient

README

Go API client for todoclient

This is a simple todo list API.

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: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/jancona

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
go get github.com/antihax/optional

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

import "./todoclient"

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
TodosApi	AddOne	Post /todos	adds a new ToDo
TodosApi	Delete	Delete /todos/{id}	deletes a ToDo
TodosApi	DeleteAll	Delete /todos	deletes all ToDos
TodosApi	Find	Get /todos	returns all todos
TodosApi	GetOne	Get /todos/{id}	gets a ToDo
TodosApi	Update	Patch /todos/{id}	updates a ToDo

Documentation For Models

• ModelError
• ModelToDo
• ModelToDoInput

Documentation For Authorization

Endpoints do not require authorization.

Author

jim@anconafamily.com

Documentation

Index

• Variables
• func CacheExpires(r *http.Response) time.Time
• type APIClient
  • func NewAPIClient(cfg *Configuration) *APIClient
  • func (c *APIClient) ChangeBasePath(path string)
  • func (c *APIClient) GetConfig() *Configuration
• 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)
  • func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)
• type GenericOpenAPIError
  • func (e GenericOpenAPIError) Body() []byte
  • func (e GenericOpenAPIError) Error() string
  • func (e GenericOpenAPIError) Model() interface{}
• type ModelError
• type ModelToDo
• type ModelToDoInput
• type ServerConfiguration
• type ServerVariable
• type TodosApiService
  • func (a *TodosApiService) AddOne(ctx _context.Context, todo ModelToDoInput) (ModelToDo, *_nethttp.Response, error)
  • func (a *TodosApiService) Delete(ctx _context.Context, id string) (ModelToDo, *_nethttp.Response, error)
  • func (a *TodosApiService) DeleteAll(ctx _context.Context) ([]ModelToDo, *_nethttp.Response, error)
  • func (a *TodosApiService) Find(ctx _context.Context) ([]ModelToDo, *_nethttp.Response, error)
  • func (a *TodosApiService) GetOne(ctx _context.Context, id string) (ModelToDo, *_nethttp.Response, error)
  • func (a *TodosApiService) Update(ctx _context.Context, id string, todo ModelToDoInput) (ModelToDo, *_nethttp.Response, error)

Variables

var (
	// ContextOAuth2 takes an 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 {
	TodosApi *TodosApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the To Do List API API v0.1.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)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

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 OpenAPI 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:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

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"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

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

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type GenericOpenAPIError

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

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

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

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

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type ModelError

type ModelError struct {
	Code    int32  `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

ModelError struct for ModelError

type ModelToDo

type ModelToDo struct {
	Completed bool   `json:"completed,omitempty"`
	Id        string `json:"id,omitempty"`
	Order     int32  `json:"order,omitempty"`
	Title     string `json:"title"`
	Url       string `json:"url,omitempty"`
}

ModelToDo struct for ModelToDo

type ModelToDoInput

type ModelToDoInput struct {
	Completed bool   `json:"completed,omitempty"`
	Order     int32  `json:"order,omitempty"`
	Title     string `json:"title"`
}

ModelToDoInput struct for ModelToDoInput

type ServerConfiguration

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TodosApiService

type TodosApiService service

TodosApiService TodosApi service

func (*TodosApiService) AddOne

func (a *TodosApiService) AddOne(ctx _context.Context, todo ModelToDoInput) (ModelToDo, *_nethttp.Response, error)

AddOne adds a new ToDo

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

@return ModelToDo

func (*TodosApiService) Delete

func (a *TodosApiService) Delete(ctx _context.Context, id string) (ModelToDo, *_nethttp.Response, error)

Delete deletes a ToDo

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

@return ModelToDo

func (*TodosApiService) DeleteAll

func (a *TodosApiService) DeleteAll(ctx _context.Context) ([]ModelToDo, *_nethttp.Response, error)

DeleteAll deletes all ToDos

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

@return []ModelToDo

func (*TodosApiService) Find

func (a *TodosApiService) Find(ctx _context.Context) ([]ModelToDo, *_nethttp.Response, error)

Find returns all todos

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

@return []ModelToDo

func (*TodosApiService) GetOne

func (a *TodosApiService) GetOne(ctx _context.Context, id string) (ModelToDo, *_nethttp.Response, error)

GetOne gets a ToDo

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

@return ModelToDo

func (*TodosApiService) Update

func (a *TodosApiService) Update(ctx _context.Context, id string, todo ModelToDoInput) (ModelToDo, *_nethttp.Response, error)

Update updates a ToDo

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

@return ModelToDo