Merge pull request #2071 from penpot/niwinz-improve-api-documentation-output

✨ Improve _doc endpoint output format

backend/resources/api-doc.css

@@ -85,6 +85,16 @@ header {
 .rpc-row-info > .name {
   width: 280px;
   /* font-weight: bold; */
+  border-right: 1px dotted #777;
+  padding-right: 10px;
+}
+
+.rpc-row-info > .module {
+  width: 120px;
+  font-weight: bold;
+  border-right: 1px dotted #777;
+  text-align: right;
+  padding-right: 10px;
 }
 
 .rpc-row-info > .tags > .tag > span:first-child {

backend/resources/api-doc.tmpl

@@ -26,6 +26,7 @@
             <li class="rpc-item">
               <div class="rpc-row-info">
                 {# <div class="type">{{item.type}}</div> #}
+                <div class="module">{{item.module}}:</div>
                 <div class="name">{{item.name}}</div>
                 <div class="tags">
                   <span class="tag">
@@ -53,6 +54,8 @@
             <li class="rpc-item">
               <div class="rpc-row-info">
                 {# <div class="type">{{item.type}}</div> #}
+
+                <div class="module">{{item.module}}:</div>
                 <div class="name">{{item.name}}</div>
                 <div class="tags">
                   <span class="tag">
@@ -80,6 +83,7 @@
             <li class="rpc-item">
               <div class="rpc-row-info">
                 {# <div class="type">{{item.type}}</div> #}
+                <div class="module">{{item.module}}:</div>
                 <div class="name">{{item.name}}</div>
                 <div class="tags">
                   <span class="tag">

backend/src/app/http/doc.clj

@@ -14,6 +14,7 @@
    [app.util.template :as tmpl]
    [clojure.java.io :as io]
    [clojure.spec.alpha :as s]
+   [cuerdas.core :as str]
    [integrant.core :as ig]
    [pretty-spec.core :as ps]
    [yetti.response :as yrs]))
@@ -30,25 +31,26 @@
   [methods]
   (letfn [(gen-doc [type [name f]]
             (let [mdata (meta f)]
-              ;; (prn name mdata)
               {:type (d/name type)
                :name (d/name name)
+               :module (-> (:ns mdata) (str/split ".") last)
                :auth (:auth mdata true)
                :docs (::sv/docs mdata)
                :spec (get-spec-str (::sv/spec mdata))}))]
 
     {:command-methods
-     (into []
+     (->> (:commands methods)
           (map (partial gen-doc :command))
-           (->> methods :commands (sort-by first)))
+          (sort-by (juxt :module :name)))
+
      :query-methods
-     (into []
+     (->> (:queries methods)
           (map (partial gen-doc :query))
-           (->> methods :queries (sort-by first)))
+          (sort-by (juxt :module :name)))
      :mutation-methods
-     (into []
+     (->> (:mutations methods)
-           (map (partial gen-doc :mutation))
+          (map (partial gen-doc :query))
-           (->> methods :mutations (sort-by first)))}))
+          (sort-by (juxt :module :name)))}))
 
 (defn- handler
   [methods]

backend/src/app/rpc.clj

@@ -204,8 +204,9 @@
 (defn- process-method
   [cfg vfn]
   (let [mdata (meta vfn)]
+    ;; (prn mdata)
     [(keyword (::sv/name mdata))
-     (wrap cfg (deref vfn) mdata)]))
+     (wrap cfg vfn mdata)]))
 
 (defn- resolve-query-methods
   [cfg]

backend/src/app/util/services.clj

@@ -40,9 +40,14 @@
   (comp
    (d/domap require)
    (map find-ns)
-   (mapcat ns-publics)
+   (mapcat (fn [ns]
+             (->> (ns-publics ns)
                   (map second)
-   (filter #(::spec (meta %)))))
+                  (filter #(::spec (meta %)))
+                  (map (fn [fvar]
+                         (with-meta (deref fvar)
+                           (-> (meta fvar)
+                               (assoc :ns (-> ns ns-name str)))))))))))
 
 (defn scan-ns
   [& nsyms]