routes are handled as nested vectors for AOT, passed as c-api options instead of swagger-data, read from options and transformed into a ordered map for swagger => keep routes in order & works with AOT. fixes #138

Author: ikitommi

src/compojure/api/core.clj

@@ -5,7 +5,6 @@
             [compojure.api.routes :as routes]
             [compojure.core :refer :all]
             [potemkin :refer [import-vars]]
-            [ring.swagger.middleware :as rsm]
             [ring.swagger.common :refer [extract-parameters]]
             [clojure.walk :as walk]
             backtick))
@@ -16,13 +15,11 @@
   lookup table via wrap-options. Returned handler retains the original
   meta-data."
   [handler options]
-  (let [{:keys [routes lookup] :as meta}
-        (-> handler meta (update-in [:routes] routes/route-vector-to-route-map))]
+  (let [meta (-> handler meta (assoc :options options))]
     (-> handler
-        (rsm/wrap-swagger-data routes)
         (mw/api-middleware options)
-        (mw/wrap-options {:lookup lookup})
-        (with-meta (assoc meta :options options)))))
+        (mw/wrap-options (select-keys meta [:routes :lookup]))
+        (with-meta meta))))
 
 (defmacro api
   "Returns a ring handler wrapped in compojure.api.middleware/api-middlware.

src/compojure/api/swagger.clj

@@ -305,9 +305,12 @@
          :name ::swagger
          (let [runtime-info# (rsm/get-swagger-data request#)
                base-path# {:basePath (base-path request#)}
-               options# (:ring-swagger (mw/get-options request#))]
+               options# (:ring-swagger (mw/get-options request#))
+               routes# (:routes (mw/get-options request#))
+               paths# (routes/route-vector-to-route-map routes#)]
            (ok
              (let [swagger# (merge runtime-info#
+                                   paths#
                                    base-path#
                                    ~extra-info)
                    result# (swagger2/swagger-json swagger# options#)]
@@ -340,7 +343,8 @@
   endpoint is requested. Returns either the (valid) api or throws an
   exception."
   [api]
-  (let [{:keys [routes options]} (meta api)]
+  (let [{:keys [routes options]} (meta api)
+        routes (routes/route-vector-to-route-map routes)]
     (assert (not (nil? routes)) "Api did not contain route definitions.")
     (when (swagger-api? api)
 

test/compojure/api/swagger_ordering_test.clj

@@ -26,14 +26,13 @@
       (->> app
            meta
            :routes
-           :paths
-           keys) => ["/a/1"
-                     "/a/2"
-                     "/a/3"
-                     "/a/b/4"
-                     "/a/b/5"
-                     "/a/c/6"
-                     "/a/c/7"
-                     "/a/c/8"
-                     "/a/c/9"
-                     "/a/c/10"])))
+           (map first)) => ["/a/1"
+                            "/a/2"
+                            "/a/3"
+                            "/a/b/4"
+                            "/a/b/5"
+                            "/a/c/6"
+                            "/a/c/7"
+                            "/a/c/8"
+                            "/a/c/9"
+                            "/a/c/10"])))

test/compojure/api/sweet_test.clj

@@ -5,7 +5,8 @@
             [ring.mock.request :refer :all]
             [schema.core :as s]
             [clojure.java.io :as io]
-            [scjsv.core :as scjsv]))
+            [scjsv.core :as scjsv]
+            [compojure.api.routes :as routes]))
 
 (def validate
   (scjsv/validator (slurp (io/resource "ring/swagger/v2.0_schema.json"))))
@@ -71,7 +72,7 @@
 (facts "api documentation"
   (fact "details are generated"
 
-    (-> app meta :routes)
+    (-> app meta :routes routes/route-vector-to-route-map)
 
     => {:paths {"/ping" {:get {}}
                 "/api/ping" {:get {}}