@kattebak/openapi-generator-ts 1.0.0

package/templates/go/api_doc.mustache

@@ -0,0 +1,92 @@
+# {{invokerPackage}}\{{classname}}{{#if description}}
+
+{{description}}{{/if}}
+
+All URIs are relative to *{{basePath}}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{summary}}
+{{/operation}}{{/operations}}
+
+{{#operations}}
+{{#operation}}
+
+## {{{operationId}}}
+
+> {{#if returnType}}{{{returnType}}} {{/if}}{{{operationId}}}(ctx{{#pathParams}}, {{paramName}}{{/pathParams}}){{#allParams}}{{^isPathParam}}.{{vendorExtensions.x-export-param-name}}({{paramName}}){{/isPathParam}}{{/allParams}}.Execute()
+
+{{{summary}}}{{#if notes}}
+
+{{{unespacedNotes}}}{{/if}}
+
+### Example
+
+```go
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+{{#vendorExtensions.x-go-import}}
+{{{vendorExtensions.x-go-import}}}
+{{/vendorExtensions.x-go-import}}
+	{{goImportAlias}} "{{gitHost}}/{{gitUserId}}/{{gitRepoId}}{{#isGoSubmodule}}/{{packageName}}{{/isGoSubmodule}}"
+)
+
+func main() {
+	{{#allParams}}
+	{{paramName}} := {{{vendorExtensions.x-go-example}}} // {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#if defaultValue}} (default to {{{defaultValue}}}){{/if}}
+	{{/allParams}}
+
+	configuration := {{goImportAlias}}.NewConfiguration()
+	apiClient := {{goImportAlias}}.NewAPIClient(configuration)
+	{{#if returnType}}resp, {{/if}}r, err := apiClient.{{classname}}.{{operationId}}(context.Background(){{#pathParams}}, {{paramName}}{{/pathParams}}){{#allParams}}{{^isPathParam}}.{{vendorExtensions.x-export-param-name}}({{paramName}}){{/isPathParam}}{{/allParams}}.Execute()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error when calling `{{classname}}.{{operationId}}``: %v\n", err)
+		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
+	}
+	{{#if returnType}}
+	// response from `{{operationId}}`: {{{returnType}}}
+	fmt.Fprintf(os.Stdout, "Response from `{{classname}}.{{operationId}}`: %v\n", resp)
+	{{/if}}
+}
+```
+
+### Path Parameters
+
+{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#pathParams}}{{#if @last}}
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.{{/if}}{{/pathParams}}{{#pathParams}}
+**{{paramName}}** | {{^isPrimitiveType}}{{^isFile}}[{{/isFile}}{{/isPrimitiveType}}**{{dataType}}**{{^isPrimitiveType}}{{^isFile}}]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}} | {{description}} | {{#if defaultValue}}[default to {{defaultValue}}]{{/if}}{{/pathParams}}
+
+### Other Parameters
+
+Other parameters are passed through a pointer to a api{{{nickname}}}Request struct via the builder pattern
+{{#allParams}}{{#if @last}}
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------{{/if}}{{/allParams}}{{#allParams}}
+{{^isPathParam}} **{{paramName}}** | {{#isContainer}}{{#isArray}}{{#items}}{{^isPrimitiveType}}{{^isFile}}[{{/isFile}}{{/isPrimitiveType}}**[]{{dataType}}**{{^isPrimitiveType}}{{^isFile}}]({{^baseType}}{{dataType}}{{/baseType}}{{baseType}}.md){{/isFile}}{{/isPrimitiveType}}{{/items}}{{/isArray}}{{#isMap}}{{#items}}{{^isPrimitiveType}}{{^isFile}}[{{/isFile}}{{/isPrimitiveType}}**map[string]{{dataType}}**{{^isPrimitiveType}}{{^isFile}}]({{^baseType}}{{dataType}}{{/baseType}}{{baseType}}.md){{/isFile}}{{/isPrimitiveType}}{{/items}}{{/isMap}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}{{^isFile}}[{{/isFile}}{{/isPrimitiveType}}**{{dataType}}**{{^isPrimitiveType}}{{^isFile}}]({{^baseType}}{{dataType}}{{/baseType}}{{baseType}}.md){{/isFile}}{{/isPrimitiveType}}{{/isContainer}} | {{description}} | {{#if defaultValue}}[default to {{defaultValue}}]{{/if}}{{/isPathParam}}{{/allParams}}
+
+### Return type
+
+{{#if returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/if}}{{#unless returnType}} (empty response body){{/unless}}
+
+### Authorization
+
+{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{#unless @last}}, {{/unless}}{{/authMethods}}
+
+### HTTP request headers
+
+- **Content-Type**: {{#consumes}}{{{mediaType}}}{{#unless @last}}, {{/unless}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
+- **Accept**: {{#produces}}{{{mediaType}}}{{#unless @last}}, {{/unless}}{{/produces}}{{^produces}}Not defined{{/produces}}
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
+
+{{/operation}}
+{{/operations}}

package/templates/go/api_test.mustache

@@ -0,0 +1,59 @@
+/*
+{{#if appName}}
+{{{appName}}}
+{{/if}}
+
+Testing {{classname}}Service
+
+*/
+
+// Code generated by OpenAPI Generator (https://openapi-generator.tech);
+
+package {{packageName}}
+
+import (
+	"context"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"testing"
+	{{goImportAlias}} "{{gitHost}}/{{gitUserId}}/{{gitRepoId}}{{#isGoSubmodule}}/{{packageName}}{{/isGoSubmodule}}"
+)
+
+func Test_{{packageName}}_{{classname}}Service(t *testing.T) {
+
+	configuration := {{goImportAlias}}.NewConfiguration()
+	apiClient := {{goImportAlias}}.NewAPIClient(configuration)
+
+{{#operations}}
+{{#operation}}
+	t.Run("Test {{classname}}Service {{{nickname}}}", func(t *testing.T) {
+
+		{{^pathParams}}
+		t.Skip("skip test")  // remove to run test
+		{{/pathParams}}
+		{{#pathParams}}
+		{{#if @first}}
+		t.Skip("skip test")  // remove to run test
+
+		{{/if}}
+		{{#isPrimitiveType}}
+		var {{paramName}} {{{dataType}}}
+		{{/isPrimitiveType}}
+		{{^isPrimitiveType}}
+		var {{paramName}} {{goImportAlias}}.{{{dataType}}}
+		{{/isPrimitiveType}}
+		{{/pathParams}}
+
+		{{#if returnType}}resp, {{/if}}httpRes, err := apiClient.{{classname}}.{{operationId}}(context.Background(){{#pathParams}}, {{paramName}}{{/pathParams}}).Execute()
+
+		require.Nil(t, err)
+		{{#if returnType}}
+		require.NotNil(t, resp)
+		{{/if}}
+		assert.Equal(t, 200, httpRes.StatusCode)
+
+	})
+
+{{/operation}}
+{{/operations}}
+}