Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix malli swagger defs w/ custom registries #589

Merged
merged 8 commits into from
Sep 1, 2023
Merged

Fix malli swagger defs w/ custom registries #589

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
229171c
Move more of swagger gen into malli lib
cap10morgan Mar 6, 2023
4f31304
Lift definitions to root of swagger.json
cap10morgan Mar 6, 2023
0f9b624
Merge branch 'master' into fix/malli-swagger-defs
cap10morgan Mar 18, 2023
ea3d031
Merge branch 'master' into fix/malli-swagger-defs
cap10morgan Mar 19, 2023
f237b09
Merge branch 'master' into fix/malli-swagger-defs
cap10morgan Apr 17, 2023
182524b
Update swagger test expectations for latest malli changes
cap10morgan Apr 17, 2023
9377686
Add malli swagger test w/ definitions
cap10morgan Apr 20, 2023
59812a3
Update malli swagger test expectations for definitions
cap10morgan May 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 71 additions & 4 deletions test/cljc/reitit/swagger_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
[reitit.swagger :as swagger]
[reitit.swagger-ui :as swagger-ui]
[schema.core :as s]
[spec-tools.data-spec :as ds]))
[spec-tools.data-spec :as ds]
[malli.core :as mc]))

(defn- normalize
"Normalize format of swagger spec by converting it to json and back.
Expand All @@ -22,6 +23,23 @@
j/write-value-as-string
(j/read-value j/keyword-keys-object-mapper)))

(def malli-registry
(merge
(mc/base-schemas)
(mc/predicate-schemas)
(mc/type-schemas)
{::req-key [:or :keyword :string]
::req-val [:or map? :string]
::resp-map map?
::resp-string [:string {:min 1}]}))


(def PutReqBody
(mc/schema [:map-of ::req-key ::req-val] {:registry malli-registry}))

(def PutRespBody
(mc/schema [:or ::resp-map ::resp-string] {:registry malli-registry}))

(def app
(ring/ring-handler
(ring/router
Expand Down Expand Up @@ -84,7 +102,13 @@
500 {:description "fail"}}
:handler (fn [{{{:keys [z]} :path
xs :body} :parameters}]
{:status 200, :body {:total (+ (reduce + xs) z)}})}}]]
{:status 200, :body {:total (+ (reduce + xs) z)}})}
:put {:summary "plus put with definitions"
:parameters {:body PutReqBody}
:responses {200 {:body PutRespBody}
500 {:description "fail"}}
:handler (fn [{{body :body} :parameters}]
{:status 200, :body (str "got " body)})}}]]

["/schema" {:coercion schema/coercion}
["/plus/*z"
Expand Down Expand Up @@ -138,7 +162,15 @@
expected {:x-id #{::math}
:swagger "2.0"
:info {:title "my-api"}
:definitions {}
:definitions {::req-key {:type "string"
:x-anyOf [{:type "string"}
{:type "string"}]}
::req-val {:type "object"
:x-anyOf [{:type "object"}
{:type "string"}]}
::resp-map {:type "object"},
::resp-string {:type "string"
:minLength 1}}
:paths {"/api/spec/plus/{z}" {:patch {:parameters []
:summary "patch"
:operationId "Patch"
Expand Down Expand Up @@ -250,7 +282,42 @@
:description "kosh"}
500 {:description "fail"}}
:definitions nil
:summary "plus with body"}}
:summary "plus with body"}
:put {:parameters [{:in "body"
:name "body"
:description ""
:required true
:schema
{:type "object"
:additionalProperties
{:$ref "#/definitions/reitit.swagger-test~1req-val"}
:definitions {::req-key
{:type "string"
:x-anyOf [{:type "string"}
{:type "string"}]}
::req-val
{:type "object"
:x-anyOf [{:type "object"}
{:type "string"}]}}}}]
:responses {200
{:schema
{:$ref "#/definitions/reitit.swagger-test~1resp-map"
:x-anyOf [{:$ref "#/definitions/reitit.swagger-test~1resp-map"}
{:$ref "#/definitions/reitit.swagger-test~1resp-string"}]
:definitions {::resp-map {:type "object"}
::resp-string
{:type "string", :minLength 1}}}
:description ""}
500 {:description "fail"}}
:definitions {::req-key {:type "string"
:x-anyOf [{:type "string"}
{:type "string"}]}
::req-val {:type "object"
:x-anyOf [{:type "object"}
{:type "string"}]}
::resp-map {:type "object"}
::resp-string {:type "string", :minLength 1}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the :definitions are now on three levels: inside the :schema, inside :put and at the top level of the swagger spec. Is that what we want? By reading the spec, it seems only the top-level :definitions is supported.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's not ideal. Only the top-level one gets used for anything I believe. Want me to explore eliminating the others?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you can find an easy way to do that, it would be nice. I think swagger validators will complain about the intermediate ones.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The malli side of that work is in metosin/malli#900

:summary "plus put with definitions"}}
"/api/schema/plus/{z}" {:get {:parameters [{:description ""
:format "int32"
:in "query"
Expand Down