# README

Go API client for openapi

gin-http服务文档

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: 1.0
Package version: 1.0.0
Generator version: 7.6.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import openapi "github.com/yituoshiniao/openapi-client-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3013/goodsCenterLogic

Class	Method	HTTP request	Description
DefaultApi	V1CommonGenerateIdGet	Get /v1/common/generateId	雪花ID生成
AsynqAPI	AsynqV1AddAggTaskGet	Get /asynq/v1/addAggTask	asynq-添加聚合任务
AsynqAPI	AsynqV1AddTaskGet	Get /asynq/v1/addTask	asynq-add异步任务
AuthAPI	AuthV1TokenGenerateGet	Get /auth/v1/token/generate	jwt-token生成及校验
ExampleAPI	V1ExampleGetGet	Get /v1/exampleGet	get接口示例
ExampleAPI	V1ExampleGetOneGet	Get /v1/exampleGetOne	getOne接口示例
ExampleAPI	V1ExamplePostPost	Post /v1/examplePost	post 接口示例
UserScoreAPI	V1UserScoreAddPost	Post /v1/userScore/add	添加数据
UserScoreAPI	V1UserScoreDelPost	Post /v1/userScore/del	删除数据
UserScoreAPI	V1UserScoreFindGet	Get /v1/userScore/find	查询一条数据
UserScoreAPI	V1UserScoreListGet	Get /v1/userScore/list	查询列表
UserScoreAPI	V1UserScoreUpdatePost	Post /v1/userScore/update	更新数据

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime