luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2026-01-28 17:00:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add examples for Swagger parameter description

Browse source
This commit is contained in:
Juho Teperi 2021-03-11 20:55:52 +02:00
parent 349c838de4
commit 8a205002a8
3 changed files with 30 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
examples/ring-malli-swagger/src/example/server.clj
View file

@ -56,13 +56,25 @@
["/plus" ["/plus"
{:get {:summary "plus with malli query parameters" {:get {:summary "plus with malli query parameters"
:parameters {:query [:map [:x int?] [:y int?]]} :parameters {:query [:map
[:x
{:title "X parameter"
:description "Description for X parameter"
:json-schema/default 42}
int?]
[:y int?]]}
:responses {200 {:body [:map [:total int?]]}} :responses {200 {:body [:map [:total int?]]}}
:handler (fn [{{{:keys [x y]} :query} :parameters}] :handler (fn [{{{:keys [x y]} :query} :parameters}]
{:status 200 {:status 200
:body {:total (+ x y)}})} :body {:total (+ x y)}})}
:post {:summary "plus with malli body parameters" :post {:summary "plus with malli body parameters"
:parameters {:body [:map [:x int?] [:y int?]]} :parameters {:body [:map
[:x
{:title "X parameter"
:description "Description for X parameter"
:json-schema/default 42}
int?]
[:y int?]]}
:responses {200 {:body [:map [:total int?]]}} :responses {200 {:body [:map [:total int?]]}}
:handler (fn [{{{:keys [x y]} :body} :parameters}] :handler (fn [{{{:keys [x y]} :body} :parameters}]
{:status 200 {:status 200

8
examples/ring-spec-swagger/src/example/server.clj
View file

@ -13,6 +13,7 @@
; [reitit.ring.middleware.dev :as dev] ; [reitit.ring.middleware.dev :as dev]
; [reitit.ring.spec :as spec] ; [reitit.ring.spec :as spec]
; [spec-tools.spell :as spell] ; [spec-tools.spell :as spell]
[spec-tools.data-spec :as ds]
[ring.adapter.jetty :as jetty] [ring.adapter.jetty :as jetty]
[muuntaja.core :as m] [muuntaja.core :as m]
[clojure.spec.alpha :as s] [clojure.spec.alpha :as s]
@ -25,7 +26,12 @@
(s/def ::size int?) (s/def ::size int?)
(s/def ::file-response (s/keys :req-un [::name ::size])) (s/def ::file-response (s/keys :req-un [::name ::size]))
(s/def ::x int?) ;; Use data-specs to provide extra JSON-Schema properties:
;; https://github.com/metosin/spec-tools/blob/master/docs/04_json_schema.md#annotated-specs
(s/def ::x (ds/spec {:spec int?
:name "X parameter"
:description "Description for X parameter"
:json-schema/default 42}))
(s/def ::y int?) (s/def ::y int?)
(s/def ::total int?) (s/def ::total int?)
(s/def ::math-request (s/keys :req-un [::x ::y])) (s/def ::math-request (s/keys :req-un [::x ::y]))

13
examples/ring-swagger/src/example/server.clj
View file

@ -11,8 +11,7 @@
[reitit.ring.middleware.parameters :as parameters] [reitit.ring.middleware.parameters :as parameters]
;; Uncomment to use ;; Uncomment to use
; [reitit.ring.middleware.dev :as dev] ; [reitit.ring.middleware.dev :as dev]
; [reitit.ring.spec :as spec] [schema-tools.core :as st]
; [spec-tools.spell :as spell]
[ring.adapter.jetty :as jetty] [ring.adapter.jetty :as jetty]
[muuntaja.core :as m] [muuntaja.core :as m]
[clojure.java.io :as io])) [clojure.java.io :as io]))
@ -53,13 +52,19 @@
["/plus" ["/plus"
{:get {:summary "plus with spec query parameters" {:get {:summary "plus with spec query parameters"
:parameters {:query {:x int?, :y int?}} :parameters {:query {:x (st/schema int? {:title "X parameter"
:description "Description for X parameter"
:json-schema/default 42})
:y int?}}
:responses {200 {:body {:total int?}}} :responses {200 {:body {:total int?}}}
:handler (fn [{{{:keys [x y]} :query} :parameters}] :handler (fn [{{{:keys [x y]} :query} :parameters}]
{:status 200 {:status 200
:body {:total (+ x y)}})} :body {:total (+ x y)}})}
:post {:summary "plus with spec body parameters" :post {:summary "plus with spec body parameters"
:parameters {:body {:x int?, :y int?}} :parameters {:body {:x int? #_(st/schema int? {:name "X parameter"
:description "Description for X parameter"
:json-schema/default 42})
:y int?}}
:responses {200 {:body {:total int?}}} :responses {200 {:body {:total int?}}}
:handler (fn [{{{:keys [x y]} :body} :parameters}] :handler (fn [{{{:keys [x y]} :body} :parameters}]
{:status 200 {:status 200