feat: two separate service urls for oasbinder and enduser (#4)

Author: walkowif

.goreleaser.yaml

@@ -1,4 +1,5 @@
 # Customization options: https://goreleaser.com/customization/
+version: 2
 project_name: oasbinder
 before:
   hooks:
@@ -23,18 +24,21 @@ checksum:
   algorithm: sha512
 changelog:
   sort: asc
-dockers:
-  - goos: linux
-    goarch: amd64
-    image_templates:
-    - "ghcr.io/insightsengineering/{{ .ProjectName }}:{{ .Version }}"
-    - "ghcr.io/insightsengineering/{{ .ProjectName }}:latest"
-    skip_push: false
-    build_flag_templates:
-    - "--pull"
-    - "--label=org.opencontainers.image.created={{ .Date }}"
-    - "--label=org.opencontainers.image.title={{ .ProjectName }}"
-    - "--label=org.opencontainers.image.revision={{ .FullCommit }}"
-    - "--label=org.opencontainers.image.version={{ .Version }}"
-    - "--build-arg=PROJECT_NAME={{ .ProjectName }}"
-    - "--platform=linux/amd64"
+kos:
+  - repositories:
+      - "ghcr.io/insightsengineering/oasbinder"
+    tags:
+      - "v{{.Version}}"
+      - latest
+    bare: true
+    preserve_import_paths: false
+    platforms:
+      - linux/amd64
+      - linux/arm64
+      - darwin/amd64
+      - darwin/arm64
+    labels:
+      "org.opencontainers.image.created": "{{ .Date }}"
+      "org.opencontainers.image.title": "{{ .ProjectName }}"
+      "org.opencontainers.image.revision": "{{ .FullCommit }}"
+      "org.opencontainers.image.version": "{{ .Version }}"

Makefile

@@ -27,7 +27,7 @@ devdeps: ## Install development dependencies
 	@printf "Executing target: [$@] 🎯\n"
 	@which -a golangci-lint > /dev/null || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOPATH) v1.51.2
 	@which -a typex > /dev/null || go install github.com/dtgorski/typex@latest
-	@which -a goreleaser > /dev/null || go install github.com/goreleaser/goreleaser@latest
+	@which -a goreleaser > /dev/null || go install github.com/goreleaser/goreleaser/v2@latest
 	@which -a gocover-cobertura > /dev/null || go install github.com/boumenot/gocover-cobertura@latest
 	@which -a misspell > /dev/null || go install github.com/client9/misspell/cmd/misspell@latest
 	@which -a gotestdox > /dev/null || go install github.com/bitfield/gotestdox/cmd/gotestdox@latest

README.md

@@ -8,14 +8,16 @@ Let's assume we have the following service in the configuration file and the use
 ```yaml
 services:
   - endpoint: /hogwarts
-    url: http://localhost:8000/hogwarts/
+    url: http://host.docker.internal:8000/hogwarts/
+    swagger_url: http://localhost:8000/hogwarts/
 ```
 
-User can request the OAS docs for the `hogwarts` microservice by going to <https://oasbinder.example.com/hogwarts> in the browser.
-
-`oasbinder` will request the OAS specification from the service at <http://localhost:8000/hogwarts/openapi.json> and return it to the user for viewing and interacting in the browser.
-The location of the OAS specs is configurable.
-Multiple services can be configured and user can then select them from a drop-down list.
+* User can request the OAS docs for the microservice by going to `proxyAddress + endpoint` in the browser (in this example: <https://oasbinder.example.com/hogwarts>).
+* `oasbinder` will request the OAS specification from the service at <http://host.docker.internal:8000/hogwarts/openapi.json> and return it to the user for viewing and interacting in the browser.
+* When user interacts with the API in the browser, the requests to the API will be directed to <http://localhost:8000/hogwarts/>.
+* In many cases `url` can be equal to `swagger_url`. An example of a situation where they can be different is e.g. a docker-compose setup where both `oasbinder` and the service can communicate via internal Docker network. `oasbinder` can request the OAS specs using the internal Docker hostname, and the user will send the requests using SwaggerUI to the service from the outside of the cluster via `swagger_url`.
+* The location of the OAS specs (`openapi.json` by default) is configurable. Multiple services can be configured and user can then select them from a drop-down list.
+* The drop-down list will contain the name and decription of the service retrieved from the OAS specs fields: `.info.title` and `.info.summary`.
 
 All the services will need to have CORS configured in a way which allows requests from <https://oasbinder.example.com>.
 
@@ -52,15 +54,19 @@ Example contents of configuration file:
 ```yaml
 # The address at which the user will access `oasbinder`.
 proxyAddress: http://localhost:8080
+# The address on which `oasbinder` will listen.
+listenAddress: 0.0.0.0
 # The port on which `oasbinder` will listen. This can be used in case `oasbinder` is run e.g. in a k8s cluster
 # and the user is accessing it from the outside of the cluster.
 listenPort: 8080
 
 services:
   - endpoint: /gringotts
     url: http://localhost:8000/gringotts/
+    swagger_url: http://localhost:8000/gringotts/
   - endpoint: /hogwarts
     url: http://localhost:8000/hogwarts/
+    swagger_url: http://localhost:8000/hogwarts/
 
 # Additional headers to pass to microservices, e.g. for authentication.
 headers:

cmd/root.go

@@ -83,6 +83,8 @@ in a way which makes interacting with the Swagger UI in the browser easy.`,
 			fmt.Println(`listenAddress = "` + listenAddress + `"`)
 			fmt.Println(`apiSpecsPath = "` + apiSpecsPath + `"`)
 
+			log.Debug("services = ", services)
+
 			serve()
 		},
 	}

cmd/server.go

@@ -20,9 +20,9 @@ var swaggerUITemplate string
 
 // Microservice represents configuration for each microservice
 type Microservice struct {
-	Name     string `yaml:"name"`
-	Endpoint string `yaml:"endpoint"`
-	URL      string `yaml:"url"`
+	Endpoint   string `mapstructure:"endpoint"`
+	URL        string `mapstructure:"url"`
+	SwaggerURL string `mapstructure:"swagger_url"`
 }
 
 type MicroserviceList struct {
@@ -138,8 +138,10 @@ func handler(w http.ResponseWriter, r *http.Request) {
 	for _, service := range services {
 		// Retrieve name and summary of each microservice to construct a drop-down list.
 		spec, serviceName, serviceSummary, err = GetOASSpec(service.URL)
+		log.Debug("serviceEndpoint = ", service.Endpoint)
 		if service.Endpoint == path {
-			microserviceURL = service.URL
+			microserviceURL = service.SwaggerURL
+			log.Debug("microserviceURL = ", microserviceURL)
 			// selectedSpec is the one which will be rendered by SwaggerUIBundle
 			selectedSpec = spec
 			if err != nil {