Skip to content

README.md

Latest commit

 

History

History
150 lines (103 loc) · 4.39 KB

README.md

File metadata and controls

150 lines (103 loc) · 4.39 KB

Go API client for x_auth_id_alias

This specification shows how to use x-auth-id-alias extension for API keys.

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

Installation

Import the package in a go file in your project and run go mod tidy:

import x_auth_id_alias "github.com/GIT_USER_ID/GIT_REPO_ID"

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 x_auth_id_alias.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), x_auth_id_alias.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 x_auth_id_alias.ContextOperationServerIndices and x_auth_id_alias.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io:80/v2

Class Method HTTP request Description
UsageAPI AnyKey Get /any Use any API key
UsageAPI BothKeys Get /both Use both API keys
UsageAPI KeyInHeader Get /header Use API key in header
UsageAPI KeyInQuery Get /query Use API key in query

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_key

  • Type: API key
  • API key parameter name: X-Api-Key
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: api_key and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		x_auth_id_alias.ContextAPIKeys,
		map[string]x_auth_id_alias.APIKey{
			"api_key": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

api_key_query

  • Type: API key
  • API key parameter name: api_key
  • Location: URL query string

Note, each API key must be added to a map of map[string]APIKey where the key is: api_key_query and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		x_auth_id_alias.ContextAPIKeys,
		map[string]x_auth_id_alias.APIKey{
			"api_key_query": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

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