swagger

README

Go API client for swagger

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

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:
• 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
GreetApi	Ping	Get /user/ping
UserApiApi	GetUserInfo	Get /api/user/{id}	获取用户信息
UserApiApi	Login	Post /api/user/login	登录
UserApiApi	Register	Post /api/user/register	注册
UserApiApi	SearchUser	Get /api/user/search	用户搜索

Documentation For Models

• LoginReq
• RegisterReq
• UserInfoReply
• UserInfoReq
• UserSearchReply
• UserSearchReq

Documentation For Authorization

apiKey

• Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

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 GenericSwaggerError
  • func (e GenericSwaggerError) Body() []byte
  • func (e GenericSwaggerError) Error() string
  • func (e GenericSwaggerError) Model() interface{}
• type GreetApiService
  • func (a *GreetApiService) Ping(ctx context.Context) (interface{}, *http.Response, error)
• type LoginReq
• type RegisterReq
• type UserApiApiService
  • func (a *UserApiApiService) GetUserInfo(ctx context.Context, id string, body UserInfoReq) (UserInfoReply, *http.Response, error)
  • func (a *UserApiApiService) Login(ctx context.Context, body LoginReq) (interface{}, *http.Response, error)
  • func (a *UserApiApiService) Register(ctx context.Context, body RegisterReq) (interface{}, *http.Response, error)
  • func (a *UserApiApiService) SearchUser(ctx context.Context, body UserSearchReq) (UserSearchReply, *http.Response, error)
• type UserInfoReply
• type UserInfoReq
• type UserSearchReply
• type UserSearchReq

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 {
	GreetApi *GreetApiService

	UserApiApi *UserApiApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the API v 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 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 GreetApiService

type GreetApiService service

func (*GreetApiService) Ping

func (a *GreetApiService) Ping(ctx context.Context) (interface{}, *http.Response, error)

GreetApiService

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

@return interface{}

type LoginReq

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

type RegisterReq

type RegisterReq struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	Mobile   string `json:"mobile,omitempty"`
}

type UserApiApiService

type UserApiApiService service

func (*UserApiApiService) GetUserInfo

func (a *UserApiApiService) GetUserInfo(ctx context.Context, id string, body UserInfoReq) (UserInfoReply, *http.Response, error)

UserApiApiService 获取用户信息

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

@return UserInfoReply

func (*UserApiApiService) Login

func (a *UserApiApiService) Login(ctx context.Context, body LoginReq) (interface{}, *http.Response, error)

UserApiApiService 登录

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

@return interface{}

func (*UserApiApiService) Register

func (a *UserApiApiService) Register(ctx context.Context, body RegisterReq) (interface{}, *http.Response, error)

UserApiApiService 注册 注册一个用户

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

@return interface{}

func (*UserApiApiService) SearchUser

func (a *UserApiApiService) SearchUser(ctx context.Context, body UserSearchReq) (UserSearchReply, *http.Response, error)

UserApiApiService 用户搜索

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

@return UserSearchReply

type UserInfoReply

type UserInfoReply struct {
	Name        string   `json:"name,omitempty"`
	Age         int32    `json:"age,omitempty"`
	Birthday    string   `json:"birthday,omitempty"`
	Description string   `json:"description,omitempty"`
	Tag         []string `json:"tag,omitempty"`
}

type UserInfoReq

type UserInfoReq struct {
	Id string `json:"id,omitempty"`
}

type UserSearchReply

type UserSearchReply struct {
	KeyWord []UserInfoReply `json:"KeyWord,omitempty"`
}

type UserSearchReq

type UserSearchReq struct {
	KeyWord string `json:"keyWord,omitempty"`
}