mirror of
https://github.com/penpot/penpot.git
synced 2025-05-20 21:36:10 +02:00
db689d151e
- makes the profile access more efficient (replace in-app joins to a simple select query on profile table - add partial support for access-tokens (still missing some RPC methods) - move router definitions to specific modules and simplify the main http module definitions to simple includes - simplifiy authentication code related to access-tokens and sessions - normalize db parameters with proper namespaced props - more work on convert all modules initialization to use proper specs with fully-qualified keyword config props
82 lines
2.5 KiB
Clojure
82 lines
2.5 KiB
Clojure
;; This Source Code Form is subject to the terms of the Mozilla Public
|
|
;; License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
;; file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
;;
|
|
;; Copyright (c) KALEIDOS INC
|
|
|
|
(ns app.rpc.doc
|
|
"API autogenerated documentation."
|
|
(:require
|
|
[app.common.data :as d]
|
|
[app.config :as cf]
|
|
[app.loggers.webhooks :as-alias webhooks]
|
|
[app.rpc :as-alias rpc]
|
|
[app.util.services :as sv]
|
|
[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]))
|
|
|
|
(defn- get-spec-str
|
|
[k]
|
|
(with-out-str
|
|
(ps/pprint (s/form k)
|
|
{:ns-aliases {"clojure.spec.alpha" "s"
|
|
"clojure.core.specs.alpha" "score"
|
|
"clojure.core" nil}})))
|
|
|
|
(defn- prepare-context
|
|
[methods]
|
|
(letfn [(gen-doc [type [name f]]
|
|
(let [mdata (meta f)]
|
|
{:type (d/name type)
|
|
:name (d/name name)
|
|
:module (-> (:ns mdata) (str/split ".") last)
|
|
:auth (:auth mdata true)
|
|
:webhook (::webhooks/event? mdata false)
|
|
:docs (::sv/docstring mdata)
|
|
:deprecated (::deprecated mdata)
|
|
:added (::added mdata)
|
|
:changes (some->> (::changes mdata) (partition-all 2) (map vec))
|
|
:spec (get-spec-str (::sv/spec mdata))}))]
|
|
|
|
{:version (:main cf/version)
|
|
:command-methods
|
|
(->> (:commands methods)
|
|
(map (partial gen-doc :command))
|
|
(sort-by (juxt :module :name)))
|
|
|
|
:query-methods
|
|
(->> (:queries methods)
|
|
(map (partial gen-doc :query))
|
|
(sort-by (juxt :module :name)))
|
|
|
|
:mutation-methods
|
|
(->> (:mutations methods)
|
|
(map (partial gen-doc :query))
|
|
(sort-by (juxt :module :name)))}))
|
|
|
|
(defn- handler
|
|
[methods]
|
|
(if (contains? cf/flags :backend-api-doc)
|
|
(let [context (prepare-context methods)]
|
|
(fn [_ respond _]
|
|
(respond (yrs/response 200 (-> (io/resource "app/templates/api-doc.tmpl")
|
|
(tmpl/render context))))))
|
|
(fn [_ respond _]
|
|
(respond (yrs/response 404)))))
|
|
|
|
|
|
(s/def ::routes vector?)
|
|
|
|
(defmethod ig/pre-init-spec ::routes [_]
|
|
(s/keys :req-un [::rpc/methods]))
|
|
|
|
(defmethod ig/init-key ::routes
|
|
[_ {:keys [methods] :as cfg}]
|
|
["/_doc" {:handler (handler methods)
|
|
:allowed-methods #{:get}}])
|
|
|