refactor: replace bash hacks with custom templates (#34)
This commit is contained in:
@ -13,54 +13,16 @@ docker run --rm -it -u "$(id -u):$(id -g)" \
|
|||||||
-g go \
|
-g go \
|
||||||
-i /influx/internal/api/api.yml \
|
-i /influx/internal/api/api.yml \
|
||||||
-o /influx/internal/api \
|
-o /influx/internal/api \
|
||||||
|
-t /influx/internal/api/templates \
|
||||||
--additional-properties packageName=api,enumClassPrefix=true,generateInterfaces=true
|
--additional-properties packageName=api,enumClassPrefix=true,generateInterfaces=true
|
||||||
|
|
||||||
# Clean up files we don't care about.
|
|
||||||
(
|
|
||||||
cd "${ROOT_DIR}/internal/api"
|
|
||||||
rm -rf go.mod go.sum git_push.sh api docs .openapi-generator .travis.yml .gitignore
|
|
||||||
)
|
|
||||||
|
|
||||||
# Edit the generated files.
|
# Edit the generated files.
|
||||||
(
|
(
|
||||||
cd "${ROOT_DIR}"
|
# Clean up files we don't care about.
|
||||||
|
cd "${ROOT_DIR}/internal/api"
|
||||||
|
rm -rf go.mod go.sum git_push.sh api docs .openapi-generator .travis.yml .gitignore
|
||||||
|
|
||||||
# Inject linter directives into generated files to make staticcheck happy.
|
# Clean up the generated code.
|
||||||
cat <<EOF > internal/api/client.go
|
|
||||||
//lint:file-ignore ST1005 Ignore capitalized errors, they're generated
|
|
||||||
//lint:file-ignore SA6005 Ignore old-fashioned way of comparing strings, it's generated
|
|
||||||
|
|
||||||
$(cat internal/api/client.go)
|
|
||||||
EOF
|
|
||||||
cat <<EOF > internal/api/configuration.go
|
|
||||||
//lint:file-ignore ST1005 Ignore capitalized errors, they're generated
|
|
||||||
|
|
||||||
$(cat internal/api/configuration.go)
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Remove the OAuth code from the generated files.
|
|
||||||
# We don't use OAuth, and it pulls in a huge dependency on the Google Cloud libraries.
|
|
||||||
#
|
|
||||||
# See https://github.com/OpenAPITools/openapi-generator/issues/9281 for a feature request
|
|
||||||
# to add a toggle that would prevent OAuth code from even being generated.
|
|
||||||
sed -i.bak -e '/OAuth2 authentication/,+10d' -e 's#"golang.org/x/oauth2"##' internal/api/client.go
|
|
||||||
sed -i.bak -e '/OAuth2/,+2d' internal/api/configuration.go
|
|
||||||
|
|
||||||
# Replace all uses of int32 with int64 in our generated models.
|
|
||||||
#
|
|
||||||
# See https://github.com/OpenAPITools/openapi-generator/issues/9280 for a feature request
|
|
||||||
# to make the Go generator's number-handling compliant with the spec, so we can generate int64
|
|
||||||
# fields directly without making our public docs invalid.
|
|
||||||
for m in internal/api/model_*.go; do
|
|
||||||
sed -i.bak -e 's/int32/int64/g' ${m}
|
|
||||||
done
|
|
||||||
|
|
||||||
rm internal/api/*.bak
|
|
||||||
)
|
|
||||||
|
|
||||||
# Since we deleted the generated go.mod, run `go mod tidy` to update parent dependencies.
|
|
||||||
(
|
|
||||||
cd "${ROOT_DIR}"
|
cd "${ROOT_DIR}"
|
||||||
make fmt
|
make fmt
|
||||||
go mod tidy
|
|
||||||
)
|
)
|
||||||
|
@ -53,6 +53,10 @@ func (r ApiGetHealthRequest) ZapTraceSpan(zapTraceSpan string) ApiGetHealthReque
|
|||||||
return r
|
return r
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (r ApiGetHealthRequest) GetZapTraceSpan() *string {
|
||||||
|
return r.zapTraceSpan
|
||||||
|
}
|
||||||
|
|
||||||
func (r ApiGetHealthRequest) Execute() (HealthCheck, *_nethttp.Response, error) {
|
func (r ApiGetHealthRequest) Execute() (HealthCheck, *_nethttp.Response, error) {
|
||||||
return r.ApiService.GetHealthExecute(r)
|
return r.ApiService.GetHealthExecute(r)
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,3 @@
|
|||||||
//lint:file-ignore ST1005 Ignore capitalized errors, they're generated
|
|
||||||
//lint:file-ignore SA6005 Ignore old-fashioned way of comparing strings, it's generated
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Subset of Influx API covered by Influx CLI
|
* Subset of Influx API covered by Influx CLI
|
||||||
*
|
*
|
||||||
@ -104,7 +101,7 @@ func selectHeaderAccept(accepts []string) string {
|
|||||||
// contains is a case insenstive match, finding needle in a haystack
|
// contains is a case insenstive match, finding needle in a haystack
|
||||||
func contains(haystack []string, needle string) bool {
|
func contains(haystack []string, needle string) bool {
|
||||||
for _, a := range haystack {
|
for _, a := range haystack {
|
||||||
if strings.ToLower(a) == strings.ToLower(needle) {
|
if strings.EqualFold(a, needle) {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -120,7 +117,7 @@ func typeCheckParameter(obj interface{}, expected string, name string) error {
|
|||||||
|
|
||||||
// Check the type is as expected.
|
// Check the type is as expected.
|
||||||
if reflect.TypeOf(obj).String() != expected {
|
if reflect.TypeOf(obj).String() != expected {
|
||||||
return fmt.Errorf("Expected %s to be of type %s but received %s.", name, expected, reflect.TypeOf(obj).String())
|
return fmt.Errorf("expected %s to be of type %s but received %s", name, expected, reflect.TypeOf(obj).String())
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@ -220,7 +217,7 @@ func (c *APIClient) prepareRequest(
|
|||||||
// add form parameters and file if available.
|
// add form parameters and file if available.
|
||||||
if strings.HasPrefix(headerParams["Content-Type"], "multipart/form-data") && len(formParams) > 0 || (len(fileBytes) > 0 && fileName != "") {
|
if strings.HasPrefix(headerParams["Content-Type"], "multipart/form-data") && len(formParams) > 0 || (len(fileBytes) > 0 && fileName != "") {
|
||||||
if body != nil {
|
if body != nil {
|
||||||
return nil, errors.New("Cannot specify postBody and multipart form at the same time.")
|
return nil, errors.New("cannot specify postBody and multipart form at the same time")
|
||||||
}
|
}
|
||||||
body = &bytes.Buffer{}
|
body = &bytes.Buffer{}
|
||||||
w := multipart.NewWriter(body)
|
w := multipart.NewWriter(body)
|
||||||
@ -260,7 +257,7 @@ func (c *APIClient) prepareRequest(
|
|||||||
|
|
||||||
if strings.HasPrefix(headerParams["Content-Type"], "application/x-www-form-urlencoded") && len(formParams) > 0 {
|
if strings.HasPrefix(headerParams["Content-Type"], "application/x-www-form-urlencoded") && len(formParams) > 0 {
|
||||||
if body != nil {
|
if body != nil {
|
||||||
return nil, errors.New("Cannot specify postBody and x-www-form-urlencoded form at the same time.")
|
return nil, errors.New("cannot specify postBody and x-www-form-urlencoded form at the same time")
|
||||||
}
|
}
|
||||||
body = &bytes.Buffer{}
|
body = &bytes.Buffer{}
|
||||||
body.WriteString(formParams.Encode())
|
body.WriteString(formParams.Encode())
|
||||||
@ -362,7 +359,7 @@ func (c *APIClient) decode(v interface{}, b []byte, contentType string) (err err
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
return errors.New("Unknown type with GetActualInstance but no unmarshalObj.UnmarshalJSON defined")
|
return errors.New("unknown type with GetActualInstance but no unmarshalObj.UnmarshalJSON defined")
|
||||||
}
|
}
|
||||||
} else if err = json.Unmarshal(b, v); err != nil { // simple model
|
} else if err = json.Unmarshal(b, v); err != nil { // simple model
|
||||||
return err
|
return err
|
||||||
@ -421,7 +418,7 @@ func setBody(body interface{}, contentType string) (bodyBuf *bytes.Buffer, err e
|
|||||||
}
|
}
|
||||||
|
|
||||||
if bodyBuf.Len() == 0 {
|
if bodyBuf.Len() == 0 {
|
||||||
err = fmt.Errorf("Invalid body type %s\n", contentType)
|
err = fmt.Errorf("invalid body type %s", contentType)
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
return bodyBuf, nil
|
return bodyBuf, nil
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
//lint:file-ignore ST1005 Ignore capitalized errors, they're generated
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Subset of Influx API covered by Influx CLI
|
* Subset of Influx API covered by Influx CLI
|
||||||
*
|
*
|
||||||
@ -128,7 +126,7 @@ func (c *Configuration) AddDefaultHeader(key string, value string) {
|
|||||||
// URL formats template on a index using given variables
|
// URL formats template on a index using given variables
|
||||||
func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error) {
|
func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error) {
|
||||||
if index < 0 || len(sc) <= index {
|
if index < 0 || len(sc) <= index {
|
||||||
return "", fmt.Errorf("Index %v out of range %v", index, len(sc)-1)
|
return "", fmt.Errorf("index %v out of range %v", index, len(sc)-1)
|
||||||
}
|
}
|
||||||
server := sc[index]
|
server := sc[index]
|
||||||
url := server.URL
|
url := server.URL
|
||||||
@ -143,7 +141,7 @@ func (sc ServerConfigurations) URL(index int, variables map[string]string) (stri
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if !found {
|
if !found {
|
||||||
return "", fmt.Errorf("The variable %s in the server URL has invalid value %v. Must be %v", name, value, variable.EnumValues)
|
return "", fmt.Errorf("the variable %s in the server URL has invalid value %v. Must be %v", name, value, variable.EnumValues)
|
||||||
}
|
}
|
||||||
url = strings.Replace(url, "{"+name+"}", value, -1)
|
url = strings.Replace(url, "{"+name+"}", value, -1)
|
||||||
} else {
|
} else {
|
||||||
|
24
internal/api/templates/README.md
Normal file
24
internal/api/templates/README.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
# Custom OpenAPI Templates
|
||||||
|
|
||||||
|
This directory contains custom mustache templates used by the OpenAPI code generator.
|
||||||
|
The original templates were extracted by running:
|
||||||
|
```shell
|
||||||
|
openapi-generator author template -g go
|
||||||
|
```
|
||||||
|
NOTE: This command extracts a copy of every template used by the generator, but we only
|
||||||
|
track templates that we've modified here. The generator can handle sourcing templates from
|
||||||
|
multiple locations.
|
||||||
|
|
||||||
|
## What have we changed?
|
||||||
|
|
||||||
|
`api.mustache`
|
||||||
|
* Add `GetX()` methods for each request parameter `X`, for use in unit tests
|
||||||
|
|
||||||
|
`client.mustache`
|
||||||
|
* Removed use of `golang.org/x/oauth2` to avoid its heavy dependencies
|
||||||
|
* Fixed error strings to be idiomatic according to staticcheck (lowercase, no punctuation)
|
||||||
|
* Use `strings.EqualFold` instead of comparing two `strings.ToLower` calls
|
||||||
|
|
||||||
|
`configuration.mustache`
|
||||||
|
* Deleted `ContextOAuth2` key to match modification in client
|
||||||
|
* Fixed error strings to be idiomatic according to staticcheck (lowercase, no punctuation)
|
383
internal/api/templates/api.mustache
Normal file
383
internal/api/templates/api.mustache
Normal file
@ -0,0 +1,383 @@
|
|||||||
|
{{>partial_header}}
|
||||||
|
package {{packageName}}
|
||||||
|
|
||||||
|
{{#operations}}
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
_context "context"
|
||||||
|
_ioutil "io/ioutil"
|
||||||
|
_nethttp "net/http"
|
||||||
|
_neturl "net/url"
|
||||||
|
{{#imports}} "{{import}}"
|
||||||
|
{{/imports}}
|
||||||
|
)
|
||||||
|
|
||||||
|
// Linger please
|
||||||
|
var (
|
||||||
|
_ _context.Context
|
||||||
|
)
|
||||||
|
{{#generateInterfaces}}
|
||||||
|
|
||||||
|
type {{classname}} interface {
|
||||||
|
{{#operation}}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* {{operationId}}{{#summary}} {{{.}}}{{/summary}}{{^summary}} Method for {{operationId}}{{/summary}}
|
||||||
|
{{#notes}}
|
||||||
|
* {{{unescapedNotes}}}
|
||||||
|
{{/notes}}
|
||||||
|
* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().{{#pathParams}}
|
||||||
|
* @param {{paramName}}{{#description}} {{{.}}}{{/description}}{{/pathParams}}
|
||||||
|
* @return {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request
|
||||||
|
*/
|
||||||
|
{{{nickname}}}(ctx _context.Context{{#pathParams}}, {{paramName}} {{{dataType}}}{{/pathParams}}) {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request
|
||||||
|
|
||||||
|
/*
|
||||||
|
* {{nickname}}Execute executes the request{{#returnType}}
|
||||||
|
* @return {{{.}}}{{/returnType}}
|
||||||
|
*/
|
||||||
|
{{nickname}}Execute(r {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request) ({{#returnType}}{{{.}}}, {{/returnType}}*_nethttp.Response, error)
|
||||||
|
{{/operation}}
|
||||||
|
}
|
||||||
|
{{/generateInterfaces}}
|
||||||
|
|
||||||
|
// {{classname}}Service {{classname}} service
|
||||||
|
type {{classname}}Service service
|
||||||
|
{{#operation}}
|
||||||
|
|
||||||
|
type {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request struct {
|
||||||
|
ctx _context.Context{{#generateInterfaces}}
|
||||||
|
ApiService {{classname}}
|
||||||
|
{{/generateInterfaces}}{{^generateInterfaces}}
|
||||||
|
ApiService *{{classname}}Service
|
||||||
|
{{/generateInterfaces}}
|
||||||
|
{{#allParams}}
|
||||||
|
{{paramName}} {{^isPathParam}}*{{/isPathParam}}{{{dataType}}}
|
||||||
|
{{/allParams}}
|
||||||
|
}
|
||||||
|
{{#allParams}}{{^isPathParam}}
|
||||||
|
func (r {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request) {{vendorExtensions.x-export-param-name}}({{paramName}} {{{dataType}}}) {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request {
|
||||||
|
r.{{paramName}} = &{{paramName}}
|
||||||
|
return r
|
||||||
|
}{{/isPathParam}}
|
||||||
|
|
||||||
|
func (r {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request) Get{{vendorExtensions.x-export-param-name}}() {{^isPathParam}}*{{/isPathParam}}{{{dataType}}} {
|
||||||
|
return r.{{paramName}}
|
||||||
|
}{{/allParams}}
|
||||||
|
|
||||||
|
func (r {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request) Execute() ({{#returnType}}{{{.}}}, {{/returnType}}*_nethttp.Response, error) {
|
||||||
|
return r.ApiService.{{nickname}}Execute(r)
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* {{operationId}}{{#summary}} {{{.}}}{{/summary}}{{^summary}} Method for {{operationId}}{{/summary}}
|
||||||
|
{{#notes}}
|
||||||
|
* {{{unescapedNotes}}}
|
||||||
|
{{/notes}}
|
||||||
|
* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().{{#pathParams}}
|
||||||
|
* @param {{paramName}}{{#description}} {{{.}}}{{/description}}{{/pathParams}}
|
||||||
|
* @return {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request
|
||||||
|
*/
|
||||||
|
func (a *{{{classname}}}Service) {{{nickname}}}(ctx _context.Context{{#pathParams}}, {{paramName}} {{{dataType}}}{{/pathParams}}) {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request {
|
||||||
|
return {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request{
|
||||||
|
ApiService: a,
|
||||||
|
ctx: ctx,
|
||||||
|
{{#pathParams}}
|
||||||
|
{{paramName}}: {{paramName}},
|
||||||
|
{{/pathParams}}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Execute executes the request{{#returnType}}
|
||||||
|
* @return {{{.}}}{{/returnType}}
|
||||||
|
*/
|
||||||
|
func (a *{{{classname}}}Service) {{nickname}}Execute(r {{#structPrefix}}{{&classname}}{{/structPrefix}}Api{{operationId}}Request) ({{#returnType}}{{{.}}}, {{/returnType}}*_nethttp.Response, error) {
|
||||||
|
var (
|
||||||
|
localVarHTTPMethod = _nethttp.Method{{httpMethod}}
|
||||||
|
localVarPostBody interface{}
|
||||||
|
localVarFormFileName string
|
||||||
|
localVarFileName string
|
||||||
|
localVarFileBytes []byte
|
||||||
|
{{#returnType}}
|
||||||
|
localVarReturnValue {{{.}}}
|
||||||
|
{{/returnType}}
|
||||||
|
)
|
||||||
|
|
||||||
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "{{{classname}}}Service.{{{nickname}}}")
|
||||||
|
if err != nil {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, GenericOpenAPIError{error: err.Error()}
|
||||||
|
}
|
||||||
|
|
||||||
|
localVarPath := localBasePath + "{{{path}}}"{{#pathParams}}
|
||||||
|
localVarPath = strings.Replace(localVarPath, "{"+"{{baseName}}"+"}", _neturl.PathEscape(parameterToString(r.{{paramName}}, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}")), -1){{/pathParams}}
|
||||||
|
|
||||||
|
localVarHeaderParams := make(map[string]string)
|
||||||
|
localVarQueryParams := _neturl.Values{}
|
||||||
|
localVarFormParams := _neturl.Values{}
|
||||||
|
{{#allParams}}
|
||||||
|
{{#required}}
|
||||||
|
{{^isPathParam}}
|
||||||
|
if r.{{paramName}} == nil {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, reportError("{{paramName}} is required and must be specified")
|
||||||
|
}
|
||||||
|
{{/isPathParam}}
|
||||||
|
{{#minItems}}
|
||||||
|
if len({{^isPathParam}}*{{/isPathParam}}r.{{paramName}}) < {{minItems}} {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, reportError("{{paramName}} must have at least {{minItems}} elements")
|
||||||
|
}
|
||||||
|
{{/minItems}}
|
||||||
|
{{#maxItems}}
|
||||||
|
if len({{^isPathParam}}*{{/isPathParam}}r.{{paramName}}) > {{maxItems}} {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, reportError("{{paramName}} must have less than {{maxItems}} elements")
|
||||||
|
}
|
||||||
|
{{/maxItems}}
|
||||||
|
{{#minLength}}
|
||||||
|
if strlen({{^isPathParam}}*{{/isPathParam}}r.{{paramName}}) < {{minLength}} {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, reportError("{{paramName}} must have at least {{minLength}} elements")
|
||||||
|
}
|
||||||
|
{{/minLength}}
|
||||||
|
{{#maxLength}}
|
||||||
|
if strlen({{^isPathParam}}*{{/isPathParam}}r.{{paramName}}) > {{maxLength}} {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, reportError("{{paramName}} must have less than {{maxLength}} elements")
|
||||||
|
}
|
||||||
|
{{/maxLength}}
|
||||||
|
{{#minimum}}
|
||||||
|
{{#isString}}
|
||||||
|
{{paramName}}Txt, err := atoi({{^isPathParam}}*{{/isPathParam}}r.{{paramName}})
|
||||||
|
if {{paramName}}Txt < {{minimum}} {
|
||||||
|
{{/isString}}
|
||||||
|
{{^isString}}
|
||||||
|
if {{^isPathParam}}*{{/isPathParam}}r.{{paramName}} < {{minimum}} {
|
||||||
|
{{/isString}}
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, reportError("{{paramName}} must be greater than {{minimum}}")
|
||||||
|
}
|
||||||
|
{{/minimum}}
|
||||||
|
{{#maximum}}
|
||||||
|
{{#isString}}
|
||||||
|
{{paramName}}Txt, err := atoi({{^isPathParam}}*{{/isPathParam}}r.{{paramName}})
|
||||||
|
if {{paramName}}Txt > {{maximum}} {
|
||||||
|
{{/isString}}
|
||||||
|
{{^isString}}
|
||||||
|
if {{^isPathParam}}*{{/isPathParam}}r.{{paramName}} > {{maximum}} {
|
||||||
|
{{/isString}}
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, reportError("{{paramName}} must be less than {{maximum}}")
|
||||||
|
}
|
||||||
|
{{/maximum}}
|
||||||
|
{{/required}}
|
||||||
|
{{/allParams}}
|
||||||
|
|
||||||
|
{{#queryParams}}
|
||||||
|
{{#required}}
|
||||||
|
{{#isCollectionFormatMulti}}
|
||||||
|
{
|
||||||
|
t := *r.{{paramName}}
|
||||||
|
if reflect.TypeOf(t).Kind() == reflect.Slice {
|
||||||
|
s := reflect.ValueOf(t)
|
||||||
|
for i := 0; i < s.Len(); i++ {
|
||||||
|
localVarQueryParams.Add("{{baseName}}", parameterToString(s.Index(i), "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}"))
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
localVarQueryParams.Add("{{baseName}}", parameterToString(t, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{{/isCollectionFormatMulti}}
|
||||||
|
{{^isCollectionFormatMulti}}
|
||||||
|
localVarQueryParams.Add("{{baseName}}", parameterToString(*r.{{paramName}}, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}"))
|
||||||
|
{{/isCollectionFormatMulti}}
|
||||||
|
{{/required}}
|
||||||
|
{{^required}}
|
||||||
|
if r.{{paramName}} != nil {
|
||||||
|
{{#isCollectionFormatMulti}}
|
||||||
|
t := *r.{{paramName}}
|
||||||
|
if reflect.TypeOf(t).Kind() == reflect.Slice {
|
||||||
|
s := reflect.ValueOf(t)
|
||||||
|
for i := 0; i < s.Len(); i++ {
|
||||||
|
localVarQueryParams.Add("{{baseName}}", parameterToString(s.Index(i), "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}"))
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
localVarQueryParams.Add("{{baseName}}", parameterToString(t, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}"))
|
||||||
|
}
|
||||||
|
{{/isCollectionFormatMulti}}
|
||||||
|
{{^isCollectionFormatMulti}}
|
||||||
|
localVarQueryParams.Add("{{baseName}}", parameterToString(*r.{{paramName}}, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}"))
|
||||||
|
{{/isCollectionFormatMulti}}
|
||||||
|
}
|
||||||
|
{{/required}}
|
||||||
|
{{/queryParams}}
|
||||||
|
// to determine the Content-Type header
|
||||||
|
{{=<% %>=}}
|
||||||
|
localVarHTTPContentTypes := []string{<%#consumes%>"<%&mediaType%>"<%^-last%>, <%/-last%><%/consumes%>}
|
||||||
|
<%={{ }}=%>
|
||||||
|
|
||||||
|
// set Content-Type header
|
||||||
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
||||||
|
if localVarHTTPContentType != "" {
|
||||||
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
||||||
|
}
|
||||||
|
|
||||||
|
// to determine the Accept header
|
||||||
|
{{=<% %>=}}
|
||||||
|
localVarHTTPHeaderAccepts := []string{<%#produces%>"<%&mediaType%>"<%^-last%>, <%/-last%><%/produces%>}
|
||||||
|
<%={{ }}=%>
|
||||||
|
|
||||||
|
// set Accept header
|
||||||
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
||||||
|
if localVarHTTPHeaderAccept != "" {
|
||||||
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
||||||
|
}
|
||||||
|
{{#headerParams}}
|
||||||
|
{{#required}}
|
||||||
|
localVarHeaderParams["{{baseName}}"] = parameterToString(*r.{{paramName}}, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}")
|
||||||
|
{{/required}}
|
||||||
|
{{^required}}
|
||||||
|
if r.{{paramName}} != nil {
|
||||||
|
localVarHeaderParams["{{baseName}}"] = parameterToString(*r.{{paramName}}, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}")
|
||||||
|
}
|
||||||
|
{{/required}}
|
||||||
|
{{/headerParams}}
|
||||||
|
{{#formParams}}
|
||||||
|
{{#isFile}}
|
||||||
|
localVarFormFileName = "{{baseName}}"
|
||||||
|
{{#required}}
|
||||||
|
localVarFile := *r.{{paramName}}
|
||||||
|
{{/required}}
|
||||||
|
{{^required}}
|
||||||
|
var localVarFile {{dataType}}
|
||||||
|
if r.{{paramName}} != nil {
|
||||||
|
localVarFile = *r.{{paramName}}
|
||||||
|
}
|
||||||
|
{{/required}}
|
||||||
|
if localVarFile != nil {
|
||||||
|
fbs, _ := _ioutil.ReadAll(localVarFile)
|
||||||
|
localVarFileBytes = fbs
|
||||||
|
localVarFileName = localVarFile.Name()
|
||||||
|
localVarFile.Close()
|
||||||
|
}
|
||||||
|
{{/isFile}}
|
||||||
|
{{^isFile}}
|
||||||
|
{{#required}}
|
||||||
|
localVarFormParams.Add("{{baseName}}", parameterToString(*r.{{paramName}}, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}"))
|
||||||
|
{{/required}}
|
||||||
|
{{^required}}
|
||||||
|
{{#isModel}}
|
||||||
|
if r.{{paramName}} != nil {
|
||||||
|
paramJson, err := parameterToJson(*r.{{paramName}})
|
||||||
|
if err != nil {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, err
|
||||||
|
}
|
||||||
|
localVarFormParams.Add("{{baseName}}", paramJson)
|
||||||
|
}
|
||||||
|
{{/isModel}}
|
||||||
|
{{^isModel}}
|
||||||
|
if r.{{paramName}} != nil {
|
||||||
|
localVarFormParams.Add("{{baseName}}", parameterToString(*r.{{paramName}}, "{{#collectionFormat}}{{collectionFormat}}{{/collectionFormat}}"))
|
||||||
|
}
|
||||||
|
{{/isModel}}
|
||||||
|
{{/required}}
|
||||||
|
{{/isFile}}
|
||||||
|
{{/formParams}}
|
||||||
|
{{#bodyParams}}
|
||||||
|
// body params
|
||||||
|
localVarPostBody = r.{{paramName}}
|
||||||
|
{{/bodyParams}}
|
||||||
|
{{#authMethods}}
|
||||||
|
{{#isApiKey}}
|
||||||
|
{{^isKeyInCookie}}
|
||||||
|
if r.ctx != nil {
|
||||||
|
// API Key Authentication
|
||||||
|
if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok {
|
||||||
|
{{#vendorExtensions.x-auth-id-alias}}
|
||||||
|
if apiKey, ok := auth["{{.}}"]; ok {
|
||||||
|
var key string
|
||||||
|
if prefix, ok := auth["{{name}}"]; ok && prefix.Prefix != "" {
|
||||||
|
key = prefix.Prefix + " " + apiKey.Key
|
||||||
|
} else {
|
||||||
|
key = apiKey.Key
|
||||||
|
}
|
||||||
|
{{/vendorExtensions.x-auth-id-alias}}
|
||||||
|
{{^vendorExtensions.x-auth-id-alias}}
|
||||||
|
if apiKey, ok := auth["{{name}}"]; ok {
|
||||||
|
var key string
|
||||||
|
if apiKey.Prefix != "" {
|
||||||
|
key = apiKey.Prefix + " " + apiKey.Key
|
||||||
|
} else {
|
||||||
|
key = apiKey.Key
|
||||||
|
}
|
||||||
|
{{/vendorExtensions.x-auth-id-alias}}
|
||||||
|
{{#isKeyInHeader}}
|
||||||
|
localVarHeaderParams["{{keyParamName}}"] = key
|
||||||
|
{{/isKeyInHeader}}
|
||||||
|
{{#isKeyInQuery}}
|
||||||
|
localVarQueryParams.Add("{{keyParamName}}", key)
|
||||||
|
{{/isKeyInQuery}}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{{/isKeyInCookie}}
|
||||||
|
{{/isApiKey}}
|
||||||
|
{{/authMethods}}
|
||||||
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes)
|
||||||
|
if err != nil {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
||||||
|
if err != nil || localVarHTTPResponse == nil {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}localVarHTTPResponse, err
|
||||||
|
}
|
||||||
|
|
||||||
|
localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body)
|
||||||
|
localVarHTTPResponse.Body.Close()
|
||||||
|
localVarHTTPResponse.Body = _ioutil.NopCloser(bytes.NewBuffer(localVarBody))
|
||||||
|
if err != nil {
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}localVarHTTPResponse, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if localVarHTTPResponse.StatusCode >= 300 {
|
||||||
|
newErr := GenericOpenAPIError{
|
||||||
|
body: localVarBody,
|
||||||
|
error: localVarHTTPResponse.Status,
|
||||||
|
}
|
||||||
|
{{#responses}}
|
||||||
|
{{#dataType}}
|
||||||
|
{{^is1xx}}
|
||||||
|
{{^is2xx}}
|
||||||
|
{{^wildcard}}
|
||||||
|
if localVarHTTPResponse.StatusCode == {{{code}}} {
|
||||||
|
{{/wildcard}}
|
||||||
|
var v {{{dataType}}}
|
||||||
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
||||||
|
if err != nil {
|
||||||
|
newErr.error = err.Error()
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}localVarHTTPResponse, newErr
|
||||||
|
}
|
||||||
|
newErr.model = v
|
||||||
|
{{^-last}}
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}localVarHTTPResponse, newErr
|
||||||
|
{{/-last}}
|
||||||
|
{{^wildcard}}
|
||||||
|
}
|
||||||
|
{{/wildcard}}
|
||||||
|
{{/is2xx}}
|
||||||
|
{{/is1xx}}
|
||||||
|
{{/dataType}}
|
||||||
|
{{/responses}}
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}localVarHTTPResponse, newErr
|
||||||
|
}
|
||||||
|
|
||||||
|
{{#returnType}}
|
||||||
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
||||||
|
if err != nil {
|
||||||
|
newErr := GenericOpenAPIError{
|
||||||
|
body: localVarBody,
|
||||||
|
error: err.Error(),
|
||||||
|
}
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}localVarHTTPResponse, newErr
|
||||||
|
}
|
||||||
|
|
||||||
|
{{/returnType}}
|
||||||
|
return {{#returnType}}localVarReturnValue, {{/returnType}}localVarHTTPResponse, nil
|
||||||
|
}
|
||||||
|
{{/operation}}
|
||||||
|
{{/operations}}
|
575
internal/api/templates/client.mustache
Normal file
575
internal/api/templates/client.mustache
Normal file
@ -0,0 +1,575 @@
|
|||||||
|
{{>partial_header}}
|
||||||
|
package {{packageName}}
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"encoding/xml"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"log"
|
||||||
|
"mime/multipart"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httputil"
|
||||||
|
"net/url"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
"unicode/utf8"
|
||||||
|
{{#withAWSV4Signature}}
|
||||||
|
awsv4 "github.com/aws/aws-sdk-go/aws/signer/v4"
|
||||||
|
awscredentials "github.com/aws/aws-sdk-go/aws/credentials"
|
||||||
|
{{/withAWSV4Signature}}
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
jsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:vnd\.[^;]+\+)?json)`)
|
||||||
|
xmlCheck = regexp.MustCompile(`(?i:(?:application|text)/xml)`)
|
||||||
|
)
|
||||||
|
|
||||||
|
// APIClient manages communication with the {{appName}} API v{{version}}
|
||||||
|
// In most cases there should be only one, shared, APIClient.
|
||||||
|
type APIClient struct {
|
||||||
|
cfg *Configuration
|
||||||
|
common service // Reuse a single struct instead of allocating one for each service on the heap.
|
||||||
|
|
||||||
|
// API Services
|
||||||
|
{{#apiInfo}}
|
||||||
|
{{#apis}}
|
||||||
|
{{#operations}}
|
||||||
|
|
||||||
|
{{#generateInterfaces}}
|
||||||
|
{{classname}} {{classname}}
|
||||||
|
{{/generateInterfaces}}
|
||||||
|
{{^generateInterfaces}}
|
||||||
|
{{classname}} *{{classname}}Service
|
||||||
|
{{/generateInterfaces}}
|
||||||
|
{{/operations}}
|
||||||
|
{{/apis}}
|
||||||
|
{{/apiInfo}}
|
||||||
|
}
|
||||||
|
|
||||||
|
type service struct {
|
||||||
|
client *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 NewAPIClient(cfg *Configuration) *APIClient {
|
||||||
|
if cfg.HTTPClient == nil {
|
||||||
|
cfg.HTTPClient = http.DefaultClient
|
||||||
|
}
|
||||||
|
|
||||||
|
c := &APIClient{}
|
||||||
|
c.cfg = cfg
|
||||||
|
c.common.client = c
|
||||||
|
|
||||||
|
{{#apiInfo}}
|
||||||
|
// API Services
|
||||||
|
{{#apis}}
|
||||||
|
{{#operations}}
|
||||||
|
c.{{classname}} = (*{{classname}}Service)(&c.common)
|
||||||
|
{{/operations}}
|
||||||
|
{{/apis}}
|
||||||
|
{{/apiInfo}}
|
||||||
|
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
func atoi(in string) (int, error) {
|
||||||
|
return strconv.Atoi(in)
|
||||||
|
}
|
||||||
|
|
||||||
|
// selectHeaderContentType select a content type from the available list.
|
||||||
|
func selectHeaderContentType(contentTypes []string) string {
|
||||||
|
if len(contentTypes) == 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if contains(contentTypes, "application/json") {
|
||||||
|
return "application/json"
|
||||||
|
}
|
||||||
|
return contentTypes[0] // use the first content type specified in 'consumes'
|
||||||
|
}
|
||||||
|
|
||||||
|
// selectHeaderAccept join all accept types and return
|
||||||
|
func selectHeaderAccept(accepts []string) string {
|
||||||
|
if len(accepts) == 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
if contains(accepts, "application/json") {
|
||||||
|
return "application/json"
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.Join(accepts, ",")
|
||||||
|
}
|
||||||
|
|
||||||
|
// contains is a case insenstive match, finding needle in a haystack
|
||||||
|
func contains(haystack []string, needle string) bool {
|
||||||
|
for _, a := range haystack {
|
||||||
|
if strings.EqualFold(a, needle) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify optional parameters are of the correct type.
|
||||||
|
func typeCheckParameter(obj interface{}, expected string, name string) error {
|
||||||
|
// Make sure there is an object.
|
||||||
|
if obj == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check the type is as expected.
|
||||||
|
if reflect.TypeOf(obj).String() != expected {
|
||||||
|
return fmt.Errorf("expected %s to be of type %s but received %s", name, expected, reflect.TypeOf(obj).String())
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parameterToString convert interface{} parameters to string, using a delimiter if format is provided.
|
||||||
|
func parameterToString(obj interface{}, collectionFormat string) string {
|
||||||
|
var delimiter string
|
||||||
|
|
||||||
|
switch collectionFormat {
|
||||||
|
case "pipes":
|
||||||
|
delimiter = "|"
|
||||||
|
case "ssv":
|
||||||
|
delimiter = " "
|
||||||
|
case "tsv":
|
||||||
|
delimiter = "\t"
|
||||||
|
case "csv":
|
||||||
|
delimiter = ","
|
||||||
|
}
|
||||||
|
|
||||||
|
if reflect.TypeOf(obj).Kind() == reflect.Slice {
|
||||||
|
return strings.Trim(strings.Replace(fmt.Sprint(obj), " ", delimiter, -1), "[]")
|
||||||
|
} else if t, ok := obj.(time.Time); ok {
|
||||||
|
return t.Format(time.RFC3339)
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf("%v", obj)
|
||||||
|
}
|
||||||
|
|
||||||
|
// helper for converting interface{} parameters to json strings
|
||||||
|
func parameterToJson(obj interface{}) (string, error) {
|
||||||
|
jsonBuf, err := json.Marshal(obj)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return string(jsonBuf), err
|
||||||
|
}
|
||||||
|
|
||||||
|
// callAPI do the request.
|
||||||
|
func (c *APIClient) callAPI(request *http.Request) (*http.Response, error) {
|
||||||
|
if c.cfg.Debug {
|
||||||
|
dump, err := httputil.DumpRequestOut(request, true)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
log.Printf("\n%s\n", string(dump))
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := c.cfg.HTTPClient.Do(request)
|
||||||
|
if err != nil {
|
||||||
|
return resp, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.cfg.Debug {
|
||||||
|
dump, err := httputil.DumpResponse(resp, true)
|
||||||
|
if err != nil {
|
||||||
|
return resp, err
|
||||||
|
}
|
||||||
|
log.Printf("\n%s\n", string(dump))
|
||||||
|
}
|
||||||
|
return resp, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Allow modification of underlying config for alternate implementations and testing
|
||||||
|
// Caution: modifying the configuration while live can cause data races and potentially unwanted behavior
|
||||||
|
func (c *APIClient) GetConfig() *Configuration {
|
||||||
|
return c.cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
// prepareRequest build the request
|
||||||
|
func (c *APIClient) prepareRequest(
|
||||||
|
ctx context.Context,
|
||||||
|
path string, method string,
|
||||||
|
postBody interface{},
|
||||||
|
headerParams map[string]string,
|
||||||
|
queryParams url.Values,
|
||||||
|
formParams url.Values,
|
||||||
|
formFileName string,
|
||||||
|
fileName string,
|
||||||
|
fileBytes []byte) (localVarRequest *http.Request, err error) {
|
||||||
|
|
||||||
|
var body *bytes.Buffer
|
||||||
|
|
||||||
|
// Detect postBody type and post.
|
||||||
|
if postBody != nil {
|
||||||
|
contentType := headerParams["Content-Type"]
|
||||||
|
if contentType == "" {
|
||||||
|
contentType = detectContentType(postBody)
|
||||||
|
headerParams["Content-Type"] = contentType
|
||||||
|
}
|
||||||
|
|
||||||
|
body, err = setBody(postBody, contentType)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// add form parameters and file if available.
|
||||||
|
if strings.HasPrefix(headerParams["Content-Type"], "multipart/form-data") && len(formParams) > 0 || (len(fileBytes) > 0 && fileName != "") {
|
||||||
|
if body != nil {
|
||||||
|
return nil, errors.New("cannot specify postBody and multipart form at the same time")
|
||||||
|
}
|
||||||
|
body = &bytes.Buffer{}
|
||||||
|
w := multipart.NewWriter(body)
|
||||||
|
|
||||||
|
for k, v := range formParams {
|
||||||
|
for _, iv := range v {
|
||||||
|
if strings.HasPrefix(k, "@") { // file
|
||||||
|
err = addFile(w, k[1:], iv)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
} else { // form value
|
||||||
|
w.WriteField(k, iv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(fileBytes) > 0 && fileName != "" {
|
||||||
|
w.Boundary()
|
||||||
|
//_, fileNm := filepath.Split(fileName)
|
||||||
|
part, err := w.CreateFormFile(formFileName, filepath.Base(fileName))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
_, err = part.Write(fileBytes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set the Boundary in the Content-Type
|
||||||
|
headerParams["Content-Type"] = w.FormDataContentType()
|
||||||
|
|
||||||
|
// Set Content-Length
|
||||||
|
headerParams["Content-Length"] = fmt.Sprintf("%d", body.Len())
|
||||||
|
w.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.HasPrefix(headerParams["Content-Type"], "application/x-www-form-urlencoded") && len(formParams) > 0 {
|
||||||
|
if body != nil {
|
||||||
|
return nil, errors.New("cannot specify postBody and x-www-form-urlencoded form at the same time")
|
||||||
|
}
|
||||||
|
body = &bytes.Buffer{}
|
||||||
|
body.WriteString(formParams.Encode())
|
||||||
|
// Set Content-Length
|
||||||
|
headerParams["Content-Length"] = fmt.Sprintf("%d", body.Len())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Setup path and query parameters
|
||||||
|
url, err := url.Parse(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Override request host, if applicable
|
||||||
|
if c.cfg.Host != "" {
|
||||||
|
url.Host = c.cfg.Host
|
||||||
|
}
|
||||||
|
|
||||||
|
// Override request scheme, if applicable
|
||||||
|
if c.cfg.Scheme != "" {
|
||||||
|
url.Scheme = c.cfg.Scheme
|
||||||
|
}
|
||||||
|
|
||||||
|
// Adding Query Param
|
||||||
|
query := url.Query()
|
||||||
|
for k, v := range queryParams {
|
||||||
|
for _, iv := range v {
|
||||||
|
query.Add(k, iv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Encode the parameters.
|
||||||
|
url.RawQuery = query.Encode()
|
||||||
|
|
||||||
|
// Generate a new request
|
||||||
|
if body != nil {
|
||||||
|
localVarRequest, err = http.NewRequest(method, url.String(), body)
|
||||||
|
} else {
|
||||||
|
localVarRequest, err = http.NewRequest(method, url.String(), nil)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// add header parameters, if any
|
||||||
|
if len(headerParams) > 0 {
|
||||||
|
headers := http.Header{}
|
||||||
|
for h, v := range headerParams {
|
||||||
|
headers.Set(h, v)
|
||||||
|
}
|
||||||
|
localVarRequest.Header = headers
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add the user agent to the request.
|
||||||
|
localVarRequest.Header.Add("User-Agent", c.cfg.UserAgent)
|
||||||
|
|
||||||
|
if ctx != nil {
|
||||||
|
// add context to the request
|
||||||
|
localVarRequest = localVarRequest.WithContext(ctx)
|
||||||
|
|
||||||
|
// Walk through any authentication.
|
||||||
|
|
||||||
|
// Basic HTTP Authentication
|
||||||
|
if auth, ok := ctx.Value(ContextBasicAuth).(BasicAuth); ok {
|
||||||
|
localVarRequest.SetBasicAuth(auth.UserName, auth.Password)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AccessToken Authentication
|
||||||
|
if auth, ok := ctx.Value(ContextAccessToken).(string); ok {
|
||||||
|
localVarRequest.Header.Add("Authorization", "Bearer "+auth)
|
||||||
|
}
|
||||||
|
|
||||||
|
{{#withAWSV4Signature}}
|
||||||
|
// AWS Signature v4 Authentication
|
||||||
|
if auth, ok := ctx.Value(ContextAWSv4).(AWSv4); ok {
|
||||||
|
creds := awscredentials.NewStaticCredentials(auth.AccessKey, auth.SecretKey, auth.SessionToken)
|
||||||
|
signer := awsv4.NewSigner(creds)
|
||||||
|
var reader *strings.Reader
|
||||||
|
if body == nil {
|
||||||
|
reader = strings.NewReader("")
|
||||||
|
} else {
|
||||||
|
reader = strings.NewReader(body.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Define default values for region and service to maintain backward compatibility
|
||||||
|
region := auth.Region
|
||||||
|
if region == "" {
|
||||||
|
region = "eu-west-2"
|
||||||
|
}
|
||||||
|
service := auth.Service
|
||||||
|
if service == "" {
|
||||||
|
service = "oapi"
|
||||||
|
}
|
||||||
|
|
||||||
|
timestamp := time.Now()
|
||||||
|
_, err := signer.Sign(localVarRequest, reader, service, region, timestamp)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{{/withAWSV4Signature}}
|
||||||
|
}
|
||||||
|
|
||||||
|
for header, value := range c.cfg.DefaultHeader {
|
||||||
|
localVarRequest.Header.Add(header, value)
|
||||||
|
}
|
||||||
|
{{#hasHttpSignatureMethods}}
|
||||||
|
if ctx != nil {
|
||||||
|
// HTTP Signature Authentication. All request headers must be set (including default headers)
|
||||||
|
// because the headers may be included in the signature.
|
||||||
|
if auth, ok := ctx.Value(ContextHttpSignatureAuth).(HttpSignatureAuth); ok {
|
||||||
|
err = SignRequest(ctx, localVarRequest, auth)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{{/hasHttpSignatureMethods}}
|
||||||
|
return localVarRequest, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *APIClient) decode(v interface{}, b []byte, contentType string) (err error) {
|
||||||
|
if len(b) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if s, ok := v.(*string); ok {
|
||||||
|
*s = string(b)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if xmlCheck.MatchString(contentType) {
|
||||||
|
if err = xml.Unmarshal(b, v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if jsonCheck.MatchString(contentType) {
|
||||||
|
if actualObj, ok := v.(interface{ GetActualInstance() interface{} }); ok { // oneOf, anyOf schemas
|
||||||
|
if unmarshalObj, ok := actualObj.(interface{ UnmarshalJSON([]byte) error }); ok { // make sure it has UnmarshalJSON defined
|
||||||
|
if err = unmarshalObj.UnmarshalJSON(b); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
return errors.New("unknown type with GetActualInstance but no unmarshalObj.UnmarshalJSON defined")
|
||||||
|
}
|
||||||
|
} else if err = json.Unmarshal(b, v); err != nil { // simple model
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return errors.New("undefined response type")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add a file to the multipart request
|
||||||
|
func addFile(w *multipart.Writer, fieldName, path string) error {
|
||||||
|
file, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer file.Close()
|
||||||
|
|
||||||
|
part, err := w.CreateFormFile(fieldName, filepath.Base(path))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
_, err = io.Copy(part, file)
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Prevent trying to import "fmt"
|
||||||
|
func reportError(format string, a ...interface{}) error {
|
||||||
|
return fmt.Errorf(format, a...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set request body from an interface{}
|
||||||
|
func setBody(body interface{}, contentType string) (bodyBuf *bytes.Buffer, err error) {
|
||||||
|
if bodyBuf == nil {
|
||||||
|
bodyBuf = &bytes.Buffer{}
|
||||||
|
}
|
||||||
|
|
||||||
|
if reader, ok := body.(io.Reader); ok {
|
||||||
|
_, err = bodyBuf.ReadFrom(reader)
|
||||||
|
} else if fp, ok := body.(**os.File); ok {
|
||||||
|
_, err = bodyBuf.ReadFrom(*fp)
|
||||||
|
} else if b, ok := body.([]byte); ok {
|
||||||
|
_, err = bodyBuf.Write(b)
|
||||||
|
} else if s, ok := body.(string); ok {
|
||||||
|
_, err = bodyBuf.WriteString(s)
|
||||||
|
} else if s, ok := body.(*string); ok {
|
||||||
|
_, err = bodyBuf.WriteString(*s)
|
||||||
|
} else if jsonCheck.MatchString(contentType) {
|
||||||
|
err = json.NewEncoder(bodyBuf).Encode(body)
|
||||||
|
} else if xmlCheck.MatchString(contentType) {
|
||||||
|
err = xml.NewEncoder(bodyBuf).Encode(body)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if bodyBuf.Len() == 0 {
|
||||||
|
err = fmt.Errorf("invalid body type %s", contentType)
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return bodyBuf, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// detectContentType method is used to figure out `Request.Body` content type for request header
|
||||||
|
func detectContentType(body interface{}) string {
|
||||||
|
contentType := "text/plain; charset=utf-8"
|
||||||
|
kind := reflect.TypeOf(body).Kind()
|
||||||
|
|
||||||
|
switch kind {
|
||||||
|
case reflect.Struct, reflect.Map, reflect.Ptr:
|
||||||
|
contentType = "application/json; charset=utf-8"
|
||||||
|
case reflect.String:
|
||||||
|
contentType = "text/plain; charset=utf-8"
|
||||||
|
default:
|
||||||
|
if b, ok := body.([]byte); ok {
|
||||||
|
contentType = http.DetectContentType(b)
|
||||||
|
} else if kind == reflect.Slice {
|
||||||
|
contentType = "application/json; charset=utf-8"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return contentType
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ripped from https://github.com/gregjones/httpcache/blob/master/httpcache.go
|
||||||
|
type cacheControl map[string]string
|
||||||
|
|
||||||
|
func parseCacheControl(headers http.Header) cacheControl {
|
||||||
|
cc := cacheControl{}
|
||||||
|
ccHeader := headers.Get("Cache-Control")
|
||||||
|
for _, part := range strings.Split(ccHeader, ",") {
|
||||||
|
part = strings.Trim(part, " ")
|
||||||
|
if part == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if strings.ContainsRune(part, '=') {
|
||||||
|
keyval := strings.Split(part, "=")
|
||||||
|
cc[strings.Trim(keyval[0], " ")] = strings.Trim(keyval[1], ",")
|
||||||
|
} else {
|
||||||
|
cc[part] = ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return cc
|
||||||
|
}
|
||||||
|
|
||||||
|
// CacheExpires helper function to determine remaining time before repeating a request.
|
||||||
|
func CacheExpires(r *http.Response) time.Time {
|
||||||
|
// Figure out when the cache expires.
|
||||||
|
var expires time.Time
|
||||||
|
now, err := time.Parse(time.RFC1123, r.Header.Get("date"))
|
||||||
|
if err != nil {
|
||||||
|
return time.Now()
|
||||||
|
}
|
||||||
|
respCacheControl := parseCacheControl(r.Header)
|
||||||
|
|
||||||
|
if maxAge, ok := respCacheControl["max-age"]; ok {
|
||||||
|
lifetime, err := time.ParseDuration(maxAge + "s")
|
||||||
|
if err != nil {
|
||||||
|
expires = now
|
||||||
|
} else {
|
||||||
|
expires = now.Add(lifetime)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
expiresHeader := r.Header.Get("Expires")
|
||||||
|
if expiresHeader != "" {
|
||||||
|
expires, err = time.Parse(time.RFC1123, expiresHeader)
|
||||||
|
if err != nil {
|
||||||
|
expires = now
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return expires
|
||||||
|
}
|
||||||
|
|
||||||
|
func strlen(s string) int {
|
||||||
|
return utf8.RuneCountInString(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenericOpenAPIError Provides access to the body, error and model on returned errors.
|
||||||
|
type GenericOpenAPIError struct {
|
||||||
|
body []byte
|
||||||
|
error string
|
||||||
|
model interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error returns non-empty string if there was an error.
|
||||||
|
func (e GenericOpenAPIError) Error() string {
|
||||||
|
return e.error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Body returns the raw bytes of the response
|
||||||
|
func (e GenericOpenAPIError) Body() []byte {
|
||||||
|
return e.body
|
||||||
|
}
|
||||||
|
|
||||||
|
// Model returns the unpacked model of the error
|
||||||
|
func (e GenericOpenAPIError) Model() interface{} {
|
||||||
|
return e.model
|
||||||
|
}
|
303
internal/api/templates/configuration.mustache
Normal file
303
internal/api/templates/configuration.mustache
Normal file
@ -0,0 +1,303 @@
|
|||||||
|
{{>partial_header}}
|
||||||
|
package {{packageName}}
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// contextKeys are used to identify the type of value in the context.
|
||||||
|
// Since these are string, it is possible to get a short description of the
|
||||||
|
// context key for logging and debugging using key.String().
|
||||||
|
|
||||||
|
type contextKey string
|
||||||
|
|
||||||
|
func (c contextKey) String() string {
|
||||||
|
return "auth " + string(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
// 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")
|
||||||
|
|
||||||
|
// ContextAPIKeys takes a string apikey as authentication for the request
|
||||||
|
ContextAPIKeys = contextKey("apiKeys")
|
||||||
|
|
||||||
|
{{#withAWSV4Signature}}
|
||||||
|
// ContextAWSv4 takes an Access Key and a Secret Key for signing AWS Signature v4
|
||||||
|
ContextAWSv4 = contextKey("awsv4")
|
||||||
|
|
||||||
|
{{/withAWSV4Signature}}
|
||||||
|
// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
|
||||||
|
ContextHttpSignatureAuth = contextKey("httpsignature")
|
||||||
|
|
||||||
|
// ContextServerIndex uses a server configuration from the index.
|
||||||
|
ContextServerIndex = contextKey("serverIndex")
|
||||||
|
|
||||||
|
// ContextOperationServerIndices uses a server configuration from the index mapping.
|
||||||
|
ContextOperationServerIndices = contextKey("serverOperationIndices")
|
||||||
|
|
||||||
|
// ContextServerVariables overrides a server configuration variables.
|
||||||
|
ContextServerVariables = contextKey("serverVariables")
|
||||||
|
|
||||||
|
// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
|
||||||
|
ContextOperationServerVariables = contextKey("serverOperationVariables")
|
||||||
|
)
|
||||||
|
|
||||||
|
// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
|
||||||
|
type BasicAuth struct {
|
||||||
|
UserName string `json:"userName,omitempty"`
|
||||||
|
Password string `json:"password,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// APIKey provides API key based authentication to a request passed via context using ContextAPIKey
|
||||||
|
type APIKey struct {
|
||||||
|
Key string
|
||||||
|
Prefix string
|
||||||
|
}
|
||||||
|
|
||||||
|
{{#withAWSV4Signature}}
|
||||||
|
// AWSv4 provides AWS Signature to a request passed via context using ContextAWSv4
|
||||||
|
// https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
||||||
|
type AWSv4 struct {
|
||||||
|
AccessKey string
|
||||||
|
SecretKey string
|
||||||
|
SessionToken string
|
||||||
|
Region string
|
||||||
|
Service string
|
||||||
|
}
|
||||||
|
|
||||||
|
{{/withAWSV4Signature}}
|
||||||
|
// ServerVariable stores the information about a server variable
|
||||||
|
type ServerVariable struct {
|
||||||
|
Description string
|
||||||
|
DefaultValue string
|
||||||
|
EnumValues []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// ServerConfiguration stores the information about a server
|
||||||
|
type ServerConfiguration struct {
|
||||||
|
URL string
|
||||||
|
Description string
|
||||||
|
Variables map[string]ServerVariable
|
||||||
|
}
|
||||||
|
|
||||||
|
// ServerConfigurations stores multiple ServerConfiguration items
|
||||||
|
type ServerConfigurations []ServerConfiguration
|
||||||
|
|
||||||
|
// Configuration stores the configuration of the API client
|
||||||
|
type Configuration struct {
|
||||||
|
Host string `json:"host,omitempty"`
|
||||||
|
Scheme string `json:"scheme,omitempty"`
|
||||||
|
DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
|
||||||
|
UserAgent string `json:"userAgent,omitempty"`
|
||||||
|
Debug bool `json:"debug,omitempty"`
|
||||||
|
Servers ServerConfigurations
|
||||||
|
OperationServers map[string]ServerConfigurations
|
||||||
|
HTTPClient *http.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewConfiguration returns a new Configuration object
|
||||||
|
func NewConfiguration() *Configuration {
|
||||||
|
cfg := &Configuration{
|
||||||
|
DefaultHeader: make(map[string]string),
|
||||||
|
UserAgent: "{{#httpUserAgent}}{{{.}}}{{/httpUserAgent}}{{^httpUserAgent}}OpenAPI-Generator/{{{packageVersion}}}/go{{/httpUserAgent}}",
|
||||||
|
Debug: false,
|
||||||
|
{{#servers}}
|
||||||
|
{{#-first}}
|
||||||
|
Servers: ServerConfigurations{
|
||||||
|
{{/-first}}
|
||||||
|
{
|
||||||
|
URL: "{{{url}}}",
|
||||||
|
Description: "{{{description}}}{{^description}}No description provided{{/description}}",
|
||||||
|
{{#variables}}
|
||||||
|
{{#-first}}
|
||||||
|
Variables: map[string]ServerVariable{
|
||||||
|
{{/-first}}
|
||||||
|
"{{{name}}}": ServerVariable{
|
||||||
|
Description: "{{{description}}}{{^description}}No description provided{{/description}}",
|
||||||
|
DefaultValue: "{{{defaultValue}}}",
|
||||||
|
{{#enumValues}}
|
||||||
|
{{#-first}}
|
||||||
|
EnumValues: []string{
|
||||||
|
{{/-first}}
|
||||||
|
"{{{.}}}",
|
||||||
|
{{#-last}}
|
||||||
|
},
|
||||||
|
{{/-last}}
|
||||||
|
{{/enumValues}}
|
||||||
|
},
|
||||||
|
{{#-last}}
|
||||||
|
},
|
||||||
|
{{/-last}}
|
||||||
|
{{/variables}}
|
||||||
|
},
|
||||||
|
{{#-last}}
|
||||||
|
},
|
||||||
|
{{/-last}}
|
||||||
|
{{/servers}}
|
||||||
|
{{#apiInfo}}
|
||||||
|
OperationServers: map[string]ServerConfigurations{
|
||||||
|
{{#apis}}
|
||||||
|
{{#operations}}
|
||||||
|
{{#operation}}
|
||||||
|
{{#servers}}
|
||||||
|
{{#-first}}
|
||||||
|
"{{{classname}}}Service.{{{nickname}}}": {
|
||||||
|
{{/-first}}
|
||||||
|
{
|
||||||
|
URL: "{{{url}}}",
|
||||||
|
Description: "{{{description}}}{{^description}}No description provided{{/description}}",
|
||||||
|
{{#variables}}
|
||||||
|
{{#-first}}
|
||||||
|
Variables: map[string]ServerVariable{
|
||||||
|
{{/-first}}
|
||||||
|
"{{{name}}}": ServerVariable{
|
||||||
|
Description: "{{{description}}}{{^description}}No description provided{{/description}}",
|
||||||
|
DefaultValue: "{{{defaultValue}}}",
|
||||||
|
{{#enumValues}}
|
||||||
|
{{#-first}}
|
||||||
|
EnumValues: []string{
|
||||||
|
{{/-first}}
|
||||||
|
"{{{.}}}",
|
||||||
|
{{#-last}}
|
||||||
|
},
|
||||||
|
{{/-last}}
|
||||||
|
{{/enumValues}}
|
||||||
|
},
|
||||||
|
{{#-last}}
|
||||||
|
},
|
||||||
|
{{/-last}}
|
||||||
|
{{/variables}}
|
||||||
|
},
|
||||||
|
{{#-last}}
|
||||||
|
},
|
||||||
|
{{/-last}}
|
||||||
|
{{/servers}}
|
||||||
|
{{/operation}}
|
||||||
|
{{/operations}}
|
||||||
|
{{/apis}}
|
||||||
|
},
|
||||||
|
{{/apiInfo}}
|
||||||
|
}
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddDefaultHeader adds a new HTTP header to the default header in the request
|
||||||
|
func (c *Configuration) AddDefaultHeader(key string, value string) {
|
||||||
|
c.DefaultHeader[key] = value
|
||||||
|
}
|
||||||
|
|
||||||
|
// URL formats template on a index using given variables
|
||||||
|
func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error) {
|
||||||
|
if index < 0 || len(sc) <= index {
|
||||||
|
return "", fmt.Errorf("index %v out of range %v", index, len(sc)-1)
|
||||||
|
}
|
||||||
|
server := sc[index]
|
||||||
|
url := server.URL
|
||||||
|
|
||||||
|
// go through variables and replace placeholders
|
||||||
|
for name, variable := range server.Variables {
|
||||||
|
if value, ok := variables[name]; ok {
|
||||||
|
found := bool(len(variable.EnumValues) == 0)
|
||||||
|
for _, enumValue := range variable.EnumValues {
|
||||||
|
if value == enumValue {
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
return "", fmt.Errorf("the variable %s in the server URL has invalid value %v. Must be %v", name, value, variable.EnumValues)
|
||||||
|
}
|
||||||
|
url = strings.Replace(url, "{"+name+"}", value, -1)
|
||||||
|
} else {
|
||||||
|
url = strings.Replace(url, "{"+name+"}", variable.DefaultValue, -1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return url, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ServerURL returns URL based on server settings
|
||||||
|
func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error) {
|
||||||
|
return c.Servers.URL(index, variables)
|
||||||
|
}
|
||||||
|
|
||||||
|
func getServerIndex(ctx context.Context) (int, error) {
|
||||||
|
si := ctx.Value(ContextServerIndex)
|
||||||
|
if si != nil {
|
||||||
|
if index, ok := si.(int); ok {
|
||||||
|
return index, nil
|
||||||
|
}
|
||||||
|
return 0, reportError("Invalid type %T should be int", si)
|
||||||
|
}
|
||||||
|
return 0, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func getServerOperationIndex(ctx context.Context, endpoint string) (int, error) {
|
||||||
|
osi := ctx.Value(ContextOperationServerIndices)
|
||||||
|
if osi != nil {
|
||||||
|
if operationIndices, ok := osi.(map[string]int); !ok {
|
||||||
|
return 0, reportError("Invalid type %T should be map[string]int", osi)
|
||||||
|
} else {
|
||||||
|
index, ok := operationIndices[endpoint]
|
||||||
|
if ok {
|
||||||
|
return index, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return getServerIndex(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
func getServerVariables(ctx context.Context) (map[string]string, error) {
|
||||||
|
sv := ctx.Value(ContextServerVariables)
|
||||||
|
if sv != nil {
|
||||||
|
if variables, ok := sv.(map[string]string); ok {
|
||||||
|
return variables, nil
|
||||||
|
}
|
||||||
|
return nil, reportError("ctx value of ContextServerVariables has invalid type %T should be map[string]string", sv)
|
||||||
|
}
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func getServerOperationVariables(ctx context.Context, endpoint string) (map[string]string, error) {
|
||||||
|
osv := ctx.Value(ContextOperationServerVariables)
|
||||||
|
if osv != nil {
|
||||||
|
if operationVariables, ok := osv.(map[string]map[string]string); !ok {
|
||||||
|
return nil, reportError("ctx value of ContextOperationServerVariables has invalid type %T should be map[string]map[string]string", osv)
|
||||||
|
} else {
|
||||||
|
variables, ok := operationVariables[endpoint]
|
||||||
|
if ok {
|
||||||
|
return variables, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return getServerVariables(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ServerURLWithContext returns a new server URL given an endpoint
|
||||||
|
func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error) {
|
||||||
|
sc, ok := c.OperationServers[endpoint]
|
||||||
|
if !ok {
|
||||||
|
sc = c.Servers
|
||||||
|
}
|
||||||
|
|
||||||
|
if ctx == nil {
|
||||||
|
return sc.URL(0, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
index, err := getServerOperationIndex(ctx, endpoint)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
variables, err := getServerOperationVariables(ctx, endpoint)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
return sc.URL(index, variables)
|
||||||
|
}
|
@ -30,7 +30,8 @@ func Test_PingSuccess(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
client := &testClient{
|
client := &testClient{
|
||||||
GetHealthExecuteFn: func(api.ApiGetHealthRequest) (api.HealthCheck, *http.Response, error) {
|
GetHealthExecuteFn: func(req api.ApiGetHealthRequest) (api.HealthCheck, *http.Response, error) {
|
||||||
|
require.Nil(t, req.GetZapTraceSpan())
|
||||||
return api.HealthCheck{Status: api.HEALTHCHECKSTATUS_PASS}, nil, nil
|
return api.HealthCheck{Status: api.HEALTHCHECKSTATUS_PASS}, nil, nil
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@ -42,6 +43,25 @@ func Test_PingSuccess(t *testing.T) {
|
|||||||
require.Equal(t, "OK\n", out.String())
|
require.Equal(t, "OK\n", out.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Test_PingSuccessWithTracing(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
traceId := "trace-id"
|
||||||
|
client := &testClient{
|
||||||
|
GetHealthExecuteFn: func(req api.ApiGetHealthRequest) (api.HealthCheck, *http.Response, error) {
|
||||||
|
require.NotNil(t, req.GetZapTraceSpan())
|
||||||
|
require.Equal(t, traceId, *req.GetZapTraceSpan())
|
||||||
|
return api.HealthCheck{Status: api.HEALTHCHECKSTATUS_PASS}, nil, nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
cli := &internal.CLI{Stdout: out, TraceId: traceId}
|
||||||
|
|
||||||
|
require.NoError(t, cli.Ping(context.Background(), client))
|
||||||
|
require.Equal(t, "OK\n", out.String())
|
||||||
|
}
|
||||||
|
|
||||||
func Test_PingFailedRequest(t *testing.T) {
|
func Test_PingFailedRequest(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user