swagger

package
v0.0.0-...-f210498 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 13, 2019 License: Apache-2.0 Imports: 20 Imported by: 0

README

Go API client for swagger

Blockchain

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.languages.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

Class Method HTTP request Description
AccountApi AddAccount Post /api/account/ Add a new account
AccountApi DeleteAccount Delete /api/account/{accountID} Pay for account
AccountApi FinancingByID Post /api/account/bank/{accountID} Financing
AccountApi GetAccountByID Get /api/account/{accountID} Get account by ID
AccountApi GetAllAccount Get /api/account/ Get all accounts
AccountApi TransferAccount Put /api/account/{accountID} Transfer account
AdminApi AdminLogin Post /admin/login Admin login
AdminApi DeleteAccountByAdmin Delete /admin/api/account/ Delete account
AdminApi GetAccountsByAdmin Get /admin/api/account/ Get accounts
AdminApi GetCompanysByAdmin Get /admin/api/company/ Get companys
AdminApi SetCompany Post /admin/api/company/ Set Company
UserApi CreateUser Post /api/user/ Create user
UserApi QueryUser Get /api/user/ Query user
UserApi UpdateUser Put /api/user/ Update user

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

[email protected]

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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 {
	AccountApi *AccountApiService

	AdminApi *AdminApiService

	UserApi *UserApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the 基于区块链的供应链金融平台 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 Account 

type Account struct {
	Id       int32 `json:"id,omitempty"`
	Money    int32 `json:"money,omitempty"`
	ACompany int32 `json:"ACompany,omitempty"`
	BCompany int32 `json:"BCompany,omitempty"`
}

type AccountApiService 

type AccountApiService service

func (*AccountApiService) AddAccount 

func (a *AccountApiService) AddAccount(ctx context.Context, body Account) (*http.Response, error)

AccountApiService Add a new account

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

func (*AccountApiService) DeleteAccount 

func (a *AccountApiService) DeleteAccount(ctx context.Context, accountID int32) (*http.Response, error)

AccountApiService Pay for account

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

func (*AccountApiService) FinancingByID 

func (a *AccountApiService) FinancingByID(ctx context.Context, accountID int32, companyID int32) ([]Account, *http.Response, error)

AccountApiService Financing

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountID The id of account.
  • @param companyID The id of company.

@return []Account

func (*AccountApiService) GetAccountByID 

func (a *AccountApiService) GetAccountByID(ctx context.Context, accountID int32) ([]Account, *http.Response, error)

AccountApiService Get account by ID

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

@return []Account

func (*AccountApiService) GetAllAccount 

func (a *AccountApiService) GetAllAccount(ctx context.Context, id int32) ([]Account, *http.Response, error)

AccountApiService Get all accounts

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

@return []Account

func (*AccountApiService) TransferAccount 

func (a *AccountApiService) TransferAccount(ctx context.Context, accountID int32, body Account) (*http.Response, error)

AccountApiService Transfer account

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

type Admin 

type Admin struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

type AdminApiService 

type AdminApiService service

func (*AdminApiService) AdminLogin 

func (a *AdminApiService) AdminLogin(ctx context.Context, body Admin) (*http.Response, error)

AdminApiService Admin login

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

func (*AdminApiService) DeleteAccountByAdmin 

func (a *AdminApiService) DeleteAccountByAdmin(ctx context.Context, accountID int32) (*http.Response, error)

AdminApiService Delete account

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

func (*AdminApiService) GetAccountsByAdmin 

func (a *AdminApiService) GetAccountsByAdmin(ctx context.Context) (Account, *http.Response, error)

AdminApiService Get accounts

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

@return Account

func (*AdminApiService) GetCompanysByAdmin 

func (a *AdminApiService) GetCompanysByAdmin(ctx context.Context) (Company, *http.Response, error)

AdminApiService Get companys

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

@return Company

func (*AdminApiService) SetCompany 

func (a *AdminApiService) SetCompany(ctx context.Context, body Company) (*http.Response, error)

AdminApiService Set Company

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

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 Company 

type Company struct {
	Id     int32  `json:"id,omitempty"`
	Name   string `json:"name,omitempty"`
	Trusty bool   `json:"trusty,omitempty"`
	Money  int32  `json:"money,omitempty"`
}

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 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 User 

type User struct {
	Username string   `json:"username,omitempty"`
	Password string   `json:"password,omitempty"`
	Company  *Company `json:"company,omitempty"`
}

type UserApiService 

type UserApiService service

func (*UserApiService) CreateUser 

func (a *UserApiService) CreateUser(ctx context.Context, body User) (*http.Response, error)

UserApiService Create user This can only be done by the logged in user.

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

func (*UserApiService) QueryUser 

func (a *UserApiService) QueryUser(ctx context.Context, username string, password string) (*http.Response, error)

UserApiService Query user This can only be done by the logged in user.

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

func (*UserApiService) UpdateUser 

func (a *UserApiService) UpdateUser(ctx context.Context, body User) (*http.Response, error)

UserApiService Update user

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.