Categorygithub.com/yituoshiniao/openapi-client-go
modulepackage
0.0.0-20240518101145-02159c1df18f
Repository: https://github.com/yituoshiniao/openapi-client-go.git
Documentation: pkg.go.dev

# 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

ClassMethodHTTP requestDescription
DefaultApiV1CommonGenerateIdGetGet /v1/common/generateId雪花ID生成
AsynqAPIAsynqV1AddAggTaskGetGet /asynq/v1/addAggTaskasynq-添加聚合任务
AsynqAPIAsynqV1AddTaskGetGet /asynq/v1/addTaskasynq-add异步任务
AuthAPIAuthV1TokenGenerateGetGet /auth/v1/token/generatejwt-token生成及校验
ExampleAPIV1ExampleGetGetGet /v1/exampleGetget接口示例
ExampleAPIV1ExampleGetOneGetGet /v1/exampleGetOnegetOne接口示例
ExampleAPIV1ExamplePostPostPost /v1/examplePostpost 接口 示例
UserScoreAPIV1UserScoreAddPostPost /v1/userScore/add添加数据
UserScoreAPIV1UserScoreDelPostPost /v1/userScore/del删除数据
UserScoreAPIV1UserScoreFindGetGet /v1/userScore/find查询一条数据
UserScoreAPIV1UserScoreListGetGet /v1/userScore/list查询列表
UserScoreAPIV1UserScoreUpdatePostPost /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

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewInternalApiDtoAppJwtTokenResponse instantiates a new InternalApiDtoAppJwtTokenResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoAppJwtTokenResponseWithDefaults instantiates a new InternalApiDtoAppJwtTokenResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoAppJwtTokenSwgResponse instantiates a new InternalApiDtoAppJwtTokenSwgResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoAppJwtTokenSwgResponseWithDefaults instantiates a new InternalApiDtoAppJwtTokenSwgResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoAsynqEmailDeliveryTaskAddResponse instantiates a new InternalApiDtoAsynqEmailDeliveryTaskAddResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoAsynqEmailDeliveryTaskAddResponseWithDefaults instantiates a new InternalApiDtoAsynqEmailDeliveryTaskAddResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoExampleGetOneResponse instantiates a new InternalApiDtoExampleGetOneResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoExampleGetOneResponseWithDefaults instantiates a new InternalApiDtoExampleGetOneResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoExampleGetResponse instantiates a new InternalApiDtoExampleGetResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoExampleGetResponseWithDefaults instantiates a new InternalApiDtoExampleGetResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoExamplePostRequest instantiates a new InternalApiDtoExamplePostRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoExamplePostRequestWithDefaults instantiates a new InternalApiDtoExamplePostRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoExamplePostResponse instantiates a new InternalApiDtoExamplePostResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoExamplePostResponseWithDefaults instantiates a new InternalApiDtoExamplePostResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoGroupDeliveryTaskAddResponse instantiates a new InternalApiDtoGroupDeliveryTaskAddResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoGroupDeliveryTaskAddResponseWithDefaults instantiates a new InternalApiDtoGroupDeliveryTaskAddResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoUserPortraitData instantiates a new InternalApiDtoUserPortraitData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoUserPortraitDataWithDefaults instantiates a new InternalApiDtoUserPortraitData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoUserScoreFindResponse instantiates a new InternalApiDtoUserScoreFindResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoUserScoreFindResponseWithDefaults instantiates a new InternalApiDtoUserScoreFindResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiDtoUserScoreListResponse instantiates a new InternalApiDtoUserScoreListResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiDtoUserScoreListResponseWithDefaults instantiates a new InternalApiDtoUserScoreListResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiHttpResponseData instantiates a new InternalApiHttpResponseData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiHttpResponseDataWithDefaults instantiates a new InternalApiHttpResponseData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalApiHttpServicev1HttpGenerateIDResponse instantiates a new InternalApiHttpServicev1HttpGenerateIDResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalApiHttpServicev1HttpGenerateIDResponseWithDefaults instantiates a new InternalApiHttpServicev1HttpGenerateIDResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalModuleAuthApplicationServiceAuthPayload instantiates a new InternalModuleAuthApplicationServiceAuthPayload object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalModuleAuthApplicationServiceAuthPayloadWithDefaults instantiates a new InternalModuleAuthApplicationServiceAuthPayload object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInternalModuleMockv2ApplicationEntityUserScore instantiates a new InternalModuleMockv2ApplicationEntityUserScore object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInternalModuleMockv2ApplicationEntityUserScoreWithDefaults instantiates a new InternalModuleMockv2ApplicationEntityUserScore object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
APIClient manages communication with the gin-http API API v1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
InternalApiDtoAppJwtTokenResponse struct for InternalApiDtoAppJwtTokenResponse.
InternalApiDtoAppJwtTokenSwgResponse struct for InternalApiDtoAppJwtTokenSwgResponse.
InternalApiDtoAsynqEmailDeliveryTaskAddResponse struct for InternalApiDtoAsynqEmailDeliveryTaskAddResponse.
InternalApiDtoExampleGetOneResponse struct for InternalApiDtoExampleGetOneResponse.
InternalApiDtoExampleGetResponse struct for InternalApiDtoExampleGetResponse.
InternalApiDtoExamplePostRequest struct for InternalApiDtoExamplePostRequest.
InternalApiDtoExamplePostResponse struct for InternalApiDtoExamplePostResponse.
InternalApiDtoGroupDeliveryTaskAddResponse struct for InternalApiDtoGroupDeliveryTaskAddResponse.
InternalApiDtoUserPortraitData struct for InternalApiDtoUserPortraitData.
InternalApiDtoUserScoreFindResponse struct for InternalApiDtoUserScoreFindResponse.
InternalApiDtoUserScoreListResponse struct for InternalApiDtoUserScoreListResponse.
InternalApiHttpResponseData struct for InternalApiHttpResponseData.
InternalApiHttpServicev1HttpGenerateIDResponse struct for InternalApiHttpServicev1HttpGenerateIDResponse.
InternalModuleAuthApplicationServiceAuthPayload struct for InternalModuleAuthApplicationServiceAuthPayload.
InternalModuleMockv2ApplicationEntityUserScore struct for InternalModuleMockv2ApplicationEntityUserScore.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.

# Interfaces

No description provided by the author

# Type aliases

AsynqAPIService AsynqAPI service.
AuthAPIService AuthAPI service.
DefaultApiService DefaultApi service.
ExampleAPIService ExampleAPI service.
ServerConfigurations stores multiple ServerConfiguration items.
UserScoreAPIService UserScoreAPI service.