Merge 2c1f536 into b962435

project.clj

@@ -42,7 +42,13 @@
                  [ring/ring-json "0.4.0"]
                  [ring-logger "0.7.7"]
                  [tech.gojek/sentry-clj.async "1.0.0" :exclusions [org.clojure/clojure]]
-                 [yleisradio/new-reliquary "1.1.0" :exclusions [org.clojure/clojure]]]
+                 [yleisradio/new-reliquary "1.1.0" :exclusions [org.clojure/clojure]]
+                 [metosin/ring-swagger "0.26.2"
+                  :exclusions [cheshire
+                               com.fasterxml.jackson.core/jackson-core
+                               com.fasterxml.jackson.dataformat/jackson-dataformat-smile
+                               com.fasterxml.jackson.dataformat/jackson-dataformat-cbor]]
+                 [metosin/ring-swagger-ui "3.25.3"]]
   :deploy-repositories [["clojars" {:url           "https://clojars.org/repo"
                                     :username      :env/clojars_username
                                     :password      :env/clojars_password

resources/config.test.ci.edn

@@ -31,7 +31,8 @@
             :retry                {:type    [:linear :keyword]
                                    :count   [5 :int]
                                    :enabled [true :bool]}
-            :http-server          {:port         [8010 :int]
+            :http-server          {:middlewares  {:swagger {:enabled false}}
+                                   :port         [8010 :int]
                                    :thread-count [100 :int]}
             :stream-router        {:default            {:application-id       "test"
                                                         :bootstrap-servers    "localhost:9092"

resources/config.test.edn

@@ -32,7 +32,8 @@
             :retry                {:count   [5 :int]
                                    :type    [:linear :keyword]
                                    :enabled [true :bool]}
-            :http-server          {:port         [8010 :int]
+            :http-server          {:middlewares  {:swagger {:enabled false}}
+                                   :port         [8010 :int]
                                    :thread-count [100 :int]}
             :stream-router        {:default            {:application-id       "test"
                                                         :bootstrap-servers    "localhost:9092"

src/ziggurat/config.clj

@@ -35,7 +35,8 @@
                                                                      :exchange-name "%s_dead_letter_exchange"}}
                                 :retry                {:count   5
                                                        :enabled false}
-                                :http-server          {:port         8080
+                                :http-server          {:middlewares  {:swagger {:enabled false}}
+                                                       :port         8080
                                                        :thread-count 100}}})
 
 (defn- interpolate-val [val app-name]

src/ziggurat/server/middleware.clj

@@ -7,7 +7,9 @@
             [sentry-clj.async :as sentry]
             [ziggurat.sentry :refer [sentry-reporter]]
             [ziggurat.util.map :as umap]
-            [ziggurat.metrics :as metrics]))
+            [ziggurat.metrics :as metrics]
+            [ring.swagger.swagger-ui :as rsui]
+            [ziggurat.config :refer [get-in-config]]))
 
 (defn wrap-default-content-type-json [handler]
   (fn [request]
@@ -40,3 +42,11 @@
           response-status   (:status response)]
       (metrics/increment-count ["http-server" "requests-served"] "count" {:request-uri request-uri :response-status (str response-status)})
       response)))
+
+(defn- swagger-enabled? []
+  (get-in-config [:http-server :middlewares :swagger :enabled]))
+
+(defn enable-swagger [handler]
+  (if (swagger-enabled?)
+    (rsui/wrap-swagger-ui handler {:path "/swagger-ui"})
+    handler))

src/ziggurat/server/routes.clj

@@ -27,6 +27,7 @@
       (conj (vec (concat actor-routes (get-routes))))
       (bidi/make-handler)
       (m/wrap-hyphenate)
+      (m/enable-swagger)
       (ring-defaults/wrap-defaults ring-defaults/api-defaults)
       (wrap-json-params)
       (wrap-multipart-params)

test/ziggurat/server/middleware_test.clj

@@ -1,7 +1,9 @@
 (ns ziggurat.server.middleware-test
   (:require [clojure.test :refer :all])
-  (:require [ziggurat.server.middleware :refer [wrap-with-metrics]]
-            [ziggurat.metrics :as metrics]))
+  (:require [ziggurat.server.middleware :refer [wrap-with-metrics enable-swagger]]
+            [ziggurat.config :refer [ziggurat-config]]
+            [ziggurat.metrics :as metrics]
+            [ring.swagger.swagger-ui :as rsui]))
 
 (deftest wrap-with-metrics-test
   (testing "should publish http-server metrics"
@@ -21,3 +23,21 @@
                                                 (swap! increment-count-called not)))]
         ((wrap-with-metrics handler) request)
         (is (= @increment-count-called true))))))
+
+(deftest enable-swagger-test
+  (testing "when swagger config is enabled"
+    (let [wrap-swagger-ui-call-count (atom 0)
+          handler (fn [_] {:status 200})
+          original-zig-config (ziggurat-config)]
+      (with-redefs [ziggurat-config (fn [] (assoc-in original-zig-config [:http-server :middlewares :swagger :enabled] true))
+                    rsui/wrap-swagger-ui (fn [& _] (swap! wrap-swagger-ui-call-count inc))]
+        (enable-swagger handler)
+        (is (= @wrap-swagger-ui-call-count 1)))))
+  (testing "when swagger config is disabled"
+    (let [wrap-swagger-ui-call-count (atom 0)
+          handler (fn [_] {:status 200})
+          original-zig-config (ziggurat-config)]
+      (with-redefs [ziggurat-config (fn [] (assoc-in original-zig-config [:http-server :middlewares :swagger :enabled] false))
+                    rsui/wrap-swagger-ui (fn [& _] (swap! wrap-swagger-ui-call-count inc))]
+        (enable-swagger handler)
+        (is (= @wrap-swagger-ui-call-count 0))))))