client

package

v0.0.0-...-a5345d3 Latest Latest Go to latest Published: Nov 26, 2016 License: MIT, Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/viktor-br/links-manager-server

Links

Open Source Insights

README ¶

Go API client for client

Managing links, its tags and searching.

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: 0.1.0
Package version: 1.0.0
Build date: 2016-11-21T22:05:59.230+01:00
Build package: class io.swagger.codegen.languages.GoClientCodegen

Installation

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

    "./client"

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class	Method	HTTP request	Description
DefaultApi	UserLoginPost	Post /user/login	Authentication
DefaultApi	UserPut	Put /user	User creation

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

Documentation ¶

Index ¶

type APIClient
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type Configuration
- func NewConfiguration() *Configuration
type DefaultApi
- func NewDefaultApi() *DefaultApi
- func NewDefaultApiWithBasePath(basePath string) *DefaultApi
- func (a DefaultApi) UserLoginPost(body UserAuth) (*APIResponse, error)
- func (a DefaultApi) UserPut(body User, xAuthToken string) (*APIResponse, error)
type User
type UserAuth

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 DefaultApi ¶

type DefaultApi struct {
	Configuration Configuration
}

func NewDefaultApi ¶

func NewDefaultApi() *DefaultApi

func NewDefaultApiWithBasePath ¶

func NewDefaultApiWithBasePath(basePath string) *DefaultApi

func (DefaultApi) UserLoginPost ¶

func (a DefaultApi) UserLoginPost(body UserAuth) (*APIResponse, error)

*

Authentication
Endpoint verifies user credentials and returns authentication token. *
@param body Body JSON
@return void

func (DefaultApi) UserPut ¶

func (a DefaultApi) UserPut(body User, xAuthToken string) (*APIResponse, error)

*

User creation
Endpoint creates new user *
@param body body JSON
@param xAuthToken Authentication token
@return void

type User ¶

type User struct {
	Username string `json:"username,omitempty"`

	Password string `json:"password,omitempty"`
}

type UserAuth ¶

type UserAuth struct {
	Username string `json:"username,omitempty"`

	Password string `json:"password,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL