move args into environment variable for boot configuration and add enums into query parameters

Author: okhuz

Makefile

@@ -6,7 +6,7 @@ build:
 	upx -9 ./build/openapi2krakend
 
 dockerize: build
-	docker buildx build --platform=linux/amd64 -f docker/Dockerfile -t okhuz/openapi2krakend:0.0.6 .
+	docker buildx build --platform=linux/amd64 -f docker/Dockerfile -t okhuz/openapi2krakend:0.0.7 .
 
 test:
 	go test ./... -v

README.md

@@ -19,9 +19,6 @@ files and convert.
 -directory: folder where swagger files live. default is swagger folder in repository.
 <br>
 -encoding: backend encoding for whole endpoints. default is "json".
-<br>
--global-timeout: sets global timeout, default is 3000ms, if there is a `x-timeout` attribute in any of the swagger files 
-this will be overwritten.
 
 ### Usage
 
@@ -57,9 +54,11 @@ configuration file.
 | LOG_PREFIX      | Log prefix for filtering                                                  | `string` | `[KRAKEND]`                                            |    no    |
 | LOG_SYSLOG      | Enable syslog                                                             | `bool`   | `true`                                                 |    no    |
 | LOG_STDOUT      | Enable stdout                                                             | `bool`   | `true`                                                 |    no    |
-| ENABLE_CORS     | Enable CORS plugin for KrakenD                                            | `bol`    | `false`                                                |    no    |
+| ENABLE_CORS     | Enable CORS plugin for KrakenD                                            | `bool`   | `false`                                                |    no    |
 | ALLOWED_ORIGINS | Comma seperated allowed origins, it will be used when ENABLE_CORS is true | `string` | `*`                                                    |    no    |
 | ALLOWED_METHODS | Comma seperated allowed methods, it will be used when ENABLE_CORS is true | `string` | `GET,HEAD,POST,PUT,DELETE,CONNECT,OPTIONS,TRACE,PATCH` |    no    |
+ | GLOBAL_TIMEOUT  | Sets global timeout across all endpoints                                  | `string` | `3000ms`                                               |    no    |
+| ENCODING        | Sets default encoding. Values are json, safejson, xml, rss, string, no-op | `string` | `json`                                                 |    no    |
 
 ````shell
 kubectl apply -f ./deployment

deployment/deployment.yaml

@@ -14,17 +14,21 @@ spec:
     spec:
       initContainers:
         - name: init-configuration
-          image: okhuz/openapi2krakend:0.0.6
+          image: okhuz/openapi2krakend:0.0.7
           imagePullPolicy: Always
           env:
             - name: API_URLS
               value: "<comma delimited api specification endpoints, format must be OpenAPI v3>"
+            - name: GLOBAL_TIMEOUT
+              value: "3600s"
             - name: ENABLE_LOGGING
               value: "true"
+            - name: ENCODING
+              value: "no-op"
             - name: LOG_LEVEL
               value: "DEBUG"
             - name: LOG_PREFIX
-              value: "[KRAKEND]"
+              value: "[TENERA]"
             - name: LOG_SYSLOG
               value: "false"
             - name: ENABLE_CORS

pkg/converter/converter.go

@@ -60,10 +60,14 @@ func Convert(swaggerDirectory string, encoding string, globalTimeout string) mod
 								}
 							} else if explodedParams.Type == "Array" {
 								krakendEndpoint.InsertQuerystringParams(parameter.Name)
+							} else if explodedParams.Type == "string" && explodedParams.Enum != nil {
+								krakendEndpoint.InsertQuerystringParams(parameter.Name)
 							}
 						} else {
 							krakendEndpoint.InsertQuerystringParams(parameter.Name)
 						}
+					} else if parameter.In == "header" {
+						krakendEndpoint.InsertHeadersToPass(parameter.Name)
 					}
 				}
 

pkg/main.go

@@ -4,18 +4,20 @@ import (
 	"encoding/json"
 	"flag"
 	"github.com/okhuz/openapi2krakend/pkg/converter"
+	"github.com/okhuz/openapi2krakend/pkg/utility"
 	"os"
 	"path"
 )
 
 func main() {
 	swaggerDirectory := flag.String("directory", "./swagger", "Directory of the swagger files")
-	encoding := flag.String("encoding", "json", "Sets default encoding. Values are json, safejson, xml, rss, string, no-op")
-	globalTimeout := flag.String("globalTimeout", "3000ms", "Sets global timeout")
 
 	flag.Parse()
 
-	configuration := converter.Convert(*swaggerDirectory, *encoding, *globalTimeout)
+	encoding := utility.GetEnv("ENCODING", "json");
+	globalTimeout := utility.GetEnv("GLOBAL_TIMEOUT", "3000ms")
+
+	configuration := converter.Convert(*swaggerDirectory, encoding, globalTimeout)
 
 	file, _ := json.MarshalIndent(configuration, "", " ")
 	_ = os.MkdirAll(path.Join(path.Base(""), "output"), 0777)

pkg/models/configuration.go

@@ -1,6 +1,7 @@
 package models
 
 import (
+	"github.com/okhuz/openapi2krakend/pkg/utility"
 	"strings"
 )
 
@@ -67,10 +68,10 @@ type Configuration struct {
 func NewConfiguration(outputEncoding string, timeout string) Configuration {
 	var extraConfig = make(map[string]interface{}, 15)
 
-	if getEnv("ENABLE_CORS", "false") == "true" {
+	if utility.GetEnv("ENABLE_CORS", "false") == "true" {
 		extraConfig["security/cors"] = NewCors()
 	}
-	if getEnv("ENABLE_LOGGING", "false") == "true" {
+	if utility.GetEnv("ENABLE_LOGGING", "false") == "true" {
 		extraConfig["telemetry/logging"] = NewLogging()
 	}
 

pkg/models/plugins.go

@@ -2,6 +2,7 @@ package models
 
 import (
 	"errors"
+	"github.com/okhuz/openapi2krakend/pkg/utility"
 	"log"
 	"strings"
 )
@@ -30,7 +31,7 @@ func NewLogging() Logging {
 
 func getLogLevel() (string, error) {
 	LogLevels := []string{"CRITICAL", "DEBUG", "ERROR", "INFO", "WARNING"}
-	LogLevel := strings.ToUpper(getEnv("LOG_LEVEL", "WARNING"))
+	LogLevel := strings.ToUpper(utility.GetEnv("LOG_LEVEL", "WARNING"))
 
 	for i := range LogLevels {
 		if LogLevels[i] == LogLevel {
@@ -42,19 +43,19 @@ func getLogLevel() (string, error) {
 }
 
 func getLogPrefix() string {
-	return getEnv("LOG_PREFIX", "[KRAKEND]")
+	return utility.GetEnv("LOG_PREFIX", "[KRAKEND]")
 }
 
 func getSysLog() bool {
-	if strings.ToLower(getEnv("LOG_SYSLOG", "true")) == "true" {
+	if strings.ToLower(utility.GetEnv("LOG_SYSLOG", "true")) == "true" {
 		return true
 	} else {
 		return false
 	}
 }
 
 func getStdout() bool {
-	if strings.ToLower(getEnv("LOG_STDOUT", "true")) == "true" {
+	if strings.ToLower(utility.GetEnv("LOG_STDOUT", "true")) == "true" {
 		return true
 	} else {
 		return false
@@ -69,9 +70,9 @@ type Cors struct {
 }
 
 func NewCors() Cors {
-	allowOrigins := strings.Split(getEnv("ALLOWED_ORIGINS", "*"), ",")
+	allowOrigins := strings.Split(utility.GetEnv("ALLOWED_ORIGINS", "*"), ",")
 	var allowedMethods []string
-	methodsEnv := getEnv("ALLOWED_METHODS", "")
+	methodsEnv := utility.GetEnv("ALLOWED_METHODS", "")
 	if methodsEnv != "" {
 		allowedMethods = strings.Split(methodsEnv, ",")
 	} else {

pkg/models/utility.go pkg/utility/utility.gopkg/models/utility.go renamed to pkg/utility/utility.go

@@ -1,8 +1,8 @@
-package models
+package utility
 
 import "os"
 
-func getEnv(key, fallback string) string {
+func GetEnv(key, fallback string) string {
 	if value, ok := os.LookupEnv(key); ok {
 		return value
 	}

scripts/run.sh

@@ -7,5 +7,7 @@ export LOG_PREFIX="[TEST]"
 export ALLOWED_ORIGINS=https://tenera.io
 export ENABLE_CORS=true
 export ALLOWED_METHODS="GET,POST"
+export GLOBAL_TIMEOUT="3600s"
+export ENCODING="no-op"
 
 go run ./pkg

swagger/pet-store.json

@@ -1,6 +1,5 @@
 {
   "openapi": "3.0.2",
-  "x-timeout": "30000ms",
   "info": {
     "title": "Swagger Petstore - OpenAPI 3.0",
     "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)",
@@ -48,7 +47,6 @@
   "paths": {
     "/pet": {
       "put": {
-        "x-timeout": "20000ms",
         "tags": [
           "pet"
         ],