Serve swagger under /api/swagger.json and swagger-ui (#2217)

This serves the generated `swagger.json` under `/api/swagger.json` and replaces the host with the current setting from `config.GetHTTPAddress()`. This should make the swagger output compatible with whatever host it is running on (local, prod-preview, prod, ...).

I've also added a swagger-ui container that starts up on `make dev` and is served at [http://localhost:8081/](http://localhost:8081/):

See also #165 for an old version of this.

Author: kwk

Makefile

@@ -321,10 +321,10 @@ dev: prebuild-check deps generate $(FRESH_BIN) docker-compose-up
 docker-compose-up:
 ifeq ($(UNAME_S),Darwin)
 	@echo "Running docker-compose with macOS network settings"
-	docker-compose -f docker-compose.macos.yml up -d db auth
+	docker-compose -f docker-compose.macos.yml up -d db auth swagger_ui
 else
 	@echo "Running docker-compose with Linux network settings"
-	docker-compose up -d db auth
+	docker-compose up -d db auth swagger_ui
 endif
 
 MINISHIFT_IP = `minishift ip`

docker-compose.yml

@@ -34,4 +34,10 @@ services:
       - "8089:8089"
     network_mode: "host"
     depends_on:
-      - db-auth
+      - db-auth
+  swagger_ui:
+    image: swaggerapi/swagger-ui:latest
+    ports:
+      - "8081:8080"
+    environment:
+      API_URL: "http://localhost:8080/api/swagger.json"

main.go

@@ -4,17 +4,18 @@ import (
 	"context"
 	"flag"
 	"net/http"
+	"net/url"
 	"os"
 	"os/user"
 	"runtime"
+	"strings"
 	"time"
 
-	"github.com/fabric8-services/fabric8-wit/closeable"
-
 	"github.com/fabric8-services/fabric8-wit/account"
 	"github.com/fabric8-services/fabric8-wit/app"
 	"github.com/fabric8-services/fabric8-wit/application"
 	"github.com/fabric8-services/fabric8-wit/auth"
+	"github.com/fabric8-services/fabric8-wit/closeable"
 	"github.com/fabric8-services/fabric8-wit/configuration"
 	"github.com/fabric8-services/fabric8-wit/controller"
 	witmiddleware "github.com/fabric8-services/fabric8-wit/goamiddleware"
@@ -29,6 +30,7 @@ import (
 	"github.com/fabric8-services/fabric8-wit/remoteworkitem"
 	"github.com/fabric8-services/fabric8-wit/sentry"
 	"github.com/fabric8-services/fabric8-wit/space/authz"
+	"github.com/fabric8-services/fabric8-wit/swagger"
 	"github.com/fabric8-services/fabric8-wit/token"
 	"github.com/goadesign/goa"
 	"github.com/goadesign/goa/logging/logrus"
@@ -403,6 +405,25 @@ func main() {
 	featuresCtrl := controller.NewFeaturesController(service, config)
 	app.MountFeaturesController(service, featuresCtrl)
 
+	// serve the swagger.json modified to the current host
+	service.Mux.Handle("GET", "/api/swagger.json",
+		func(res http.ResponseWriter, req *http.Request, url url.Values) {
+			b, err := swagger.Asset("swagger.json")
+			if err != nil {
+				res.WriteHeader(404)
+				return
+			}
+
+			s := string(b)
+			s = strings.Replace(s, `"host":"openshift.io"`, `"host":"`+config.GetHTTPAddress()+`"`, -1)
+
+			res.Header().Set("Access-Control-Allow-Origin", "*")
+			res.Header().Set("Access-Control-Allow-Methods", "GET")
+
+			res.Write([]byte(s))
+		},
+	)
+
 	log.Logger().Infoln("Git Commit SHA: ", controller.Commit)
 	log.Logger().Infoln("UTC Build Time: ", controller.BuildTime)
 	log.Logger().Infoln("UTC Start Time: ", controller.StartTime)