luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-17 08:21:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove operation-id uniqueness check

Browse source 
Let's leave that for other tools for now.
This commit is contained in:
Miikka Koskinen 2021-04-23 17:02:17 +03:00
parent e095cd2efa
commit 1b583c1cc2
2 changed files with 2 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
modules/reitit-swagger/src/reitit/swagger.cljc
View file

@ -13,7 +13,6 @@
(s/def ::summary string?) (s/def ::summary string?)
(s/def ::description string?) (s/def ::description string?)
(s/def ::operationId string?) (s/def ::operationId string?)
(s/def ::operationIds (s/coll-of ::operationId :distinct true))
(s/def ::swagger (s/keys :opt-un [::id])) (s/def ::swagger (s/keys :opt-un [::id]))
(s/def ::spec (s/keys :opt-un [::swagger ::no-doc ::tags ::summary ::description ::operationId])) (s/def ::spec (s/keys :opt-un [::swagger ::no-doc ::tags ::summary ::description ::operationId]))
@ -84,7 +83,6 @@
accept-route (fn [route] accept-route (fn [route]
(-> route second :swagger :id (or ::default) (trie/into-set) (set/intersection ids) seq)) (-> route second :swagger :id (or ::default) (trie/into-set) (set/intersection ids) seq))
base-swagger-spec {:responses ^:displace {:default {:description ""}}} base-swagger-spec {:responses ^:displace {:default {:description ""}}}
oid-acc (atom [])
transform-endpoint (fn [[method {{:keys [coercion no-doc swagger] :as data} :data transform-endpoint (fn [[method {{:keys [coercion no-doc swagger] :as data} :data
middleware :middleware middleware :middleware
interceptors :interceptors}]] interceptors :interceptors}]]
@ -96,21 +94,13 @@
(apply meta-merge (keep (comp :swagger :data) interceptors)) (apply meta-merge (keep (comp :swagger :data) interceptors))
(if coercion (if coercion
(coercion/get-apidocs coercion :swagger data)) (coercion/get-apidocs coercion :swagger data))
(select-keys data [:tags :summary :description]) (select-keys data [:tags :summary :description :operationId])
(let [oid (select-keys data [:operationId])
oid-val (:operationId oid)
_ (when (not (nil? oid-val))
(reset! oid-acc (conj @oid-acc oid-val)))]
oid)
(strip-top-level-keys swagger))])) (strip-top-level-keys swagger))]))
transform-path (fn [[p _ c]] transform-path (fn [[p _ c]]
(if-let [endpoint (some->> c (keep transform-endpoint) (seq) (into {}))] (if-let [endpoint (some->> c (keep transform-endpoint) (seq) (into {}))]
[(swagger-path p (r/options router)) endpoint])) [(swagger-path p (r/options router)) endpoint]))
map-in-order #(->> % (apply concat) (apply array-map)) map-in-order #(->> % (apply concat) (apply array-map))
paths (->> router (r/compiled-routes) (filter accept-route) (map transform-path) map-in-order) paths (->> router (r/compiled-routes) (filter accept-route) (map transform-path) map-in-order)]
_ (when (not (s/valid? ::operationIds @oid-acc))
(throw (ex-info (s/explain-str ::operationIds @oid-acc) {:operation-ids @oid-acc
:error "operationIds are not distinct"})))]
{:status 200 {:status 200
:body (meta-merge swagger {:paths paths})})) :body (meta-merge swagger {:paths paths})}))
([req res raise] ([req res raise]

29
test/cljc/reitit/swagger_test.clj
View file

@ -103,32 +103,6 @@
rrc/coerce-request-middleware rrc/coerce-request-middleware
rrc/coerce-response-middleware]}}))) rrc/coerce-response-middleware]}})))
(def failing-app
(ring/ring-handler
(ring/router
["/api"
{:swagger {:id ::math}}
["/swagger.json"
{:get {:no-doc true
:swagger {:info {:title "my-api"}}
:handler (swagger/create-swagger-handler)}}]
["/spec" {:coercion spec/coercion}
["/plus/:z"
{:patch {:summary "patch"
:operationId "Patch"
:handler (constantly {:status 200})}
:options {:summary "options"
:operationId "Patch"
:middleware [{:data {:swagger {:responses {200 {:description "200"}}}}}]
:handler (constantly {:status 200})}}]]]
{:data {:middleware [swagger/swagger-feature
rrc/coerce-exceptions-middleware
rrc/coerce-request-middleware
rrc/coerce-response-middleware]}})))
(require '[fipp.edn]) (require '[fipp.edn])
(deftest swagger-test (deftest swagger-test
(testing "endpoints work" (testing "endpoints work"
@ -147,9 +121,6 @@
:uri "/api/schema/plus/3" :uri "/api/schema/plus/3"
:query-params {:x "2", :y "1"}}))))) :query-params {:x "2", :y "1"}})))))
(testing "failing swagger-spec"
(is (thrown? clojure.lang.ExceptionInfo (:body (failing-app {:request-method :get
:uri "/api/swagger.json"})))))
(testing "swagger-spec" (testing "swagger-spec"
(let [spec (:body (app {:request-method :get (let [spec (:body (app {:request-method :get
:uri "/api/swagger.json"})) :uri "/api/swagger.json"}))