Skip to content

fix reflection and update readme #152

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

Merged
merged 2 commits into from
Sep 2, 2025
Merged

fix reflection and update readme #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24ffe64
fix reflection and update readme
Jul 22, 2025
f930475
Incorporate the review comments
Aug 8, 2025
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
90 changes: 87 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ring-Swagger [![Build Status](https://travis-ci.org/metosin/ring-swagger.svg?branch=master)](https://travis-ci.org/metosin/ring-swagger) [![Downloads](https://versions.deps.co/metosin/ring-swagger/downloads.svg)](https://versions.deps.co/metosin/ring-swagger)

[Swagger](http://swagger.io/) 2.0 implementation for Clojure/Ring using [Plumatic Schema](https://github.com/Plumatic/schema) (support for [clojure.spec](http://clojure.org/about/spec) via [spec-tools](https://github.com/metosin/spec-tools)).
[Swagger](http://swagger.io/) 2.0/[OpenApi](https://spec.openapis.org/oas/v3.0.3.html) 3.0 implementation for Clojure/Ring using [Plumatic Schema](https://github.com/Plumatic/schema) (support for [clojure.spec](http://clojure.org/about/spec) via [spec-tools](https://github.com/metosin/spec-tools)).

- Transforms deeply nested Schemas into Swagger JSON Schema definitions
- Extended & symmetric JSON & String serialization & coercion
Expand Down Expand Up @@ -37,7 +37,7 @@ The Schema allows mostly any extra keys as ring-swagger tries not to be on your

[API Docs](http://metosin.github.io/ring-swagger/doc/).

### Simplest possible example
### Simplest possible example for swagger 2.0

```clojure
(require '[ring.swagger.swagger2 :as rs])
Expand All @@ -51,8 +51,34 @@ The Schema allows mostly any extra keys as ring-swagger tries not to be on your
; :paths {},
; :definitions {}}
```
### Simplest possible example for openapi 3.0

### More complete example
```clojure
(require '[ring.swagger.openapi3 :as rs])
(rs/openapi-json {:info {:version "version"
:title "title"
:description "description"
:termsOfService "jeah"
:contact {:name "name"
:url "http://someurl.com"
:email "[email protected]"}
:license {:name "name"
:url "http://someurl.com"}}
:paths {}})
;{:openapi "3.0.3"
; :info {:title "title"
; :version "version"
; :description "description"
; :termsOfService "jeah"
; :contact {:name "name" :url "http://someurl.com" :email "[email protected]"}
; :license {:name "name" :url "http://someurl.com"}}
; :paths {}
; :components {:schemas {}
; :securitySchemes {}
; :responses {}
; :requestBodies {}}}
```
### More complete example for swagger 2.0

Info, tags, routes and anonymous nested schemas.

Expand Down Expand Up @@ -130,6 +156,64 @@ Info, tags, routes and anonymous nested schemas.
; :additionalProperties false,
; :required (:street :city)}}}
```
### More complete example for openapi 3.x
```clojure
(require '[schema.core :as s])
(require '[ring.swagger.openapi3 :as rs])

(s/defschema User {:id s/Str,
:name s/Str
:address {:street s/Str
:city (s/enum :tre :hki)}})


(rs/openapi-json {:info {:version "version"
:title "title"
:description "description"
:termsOfService "jeah"
:contact {:name "name"
:url "http://someurl.com"
:email "[email protected]"}
:license {:name "name"
:url "http://someurl.com"}}
:paths {"/api"
{:post
{:requestBody {:content {"application/json" User}}
:responses {200 {:description "ok"
:content {"application/json" {:schema User}}}}}}}})
;{:openapi "3.0.3",
; :info {:title "title",
; :version "version",
; :description "description",
; :termsOfService "jeah",
; :contact {:name "name", :url "http://someurl.com", :email "[email protected]"},
; :license {:name "name", :url "http://someurl.com"}},
; :paths {"/api" {:post {:requestBody {:$ref "#/components/requestBodies/User"},
; :responses {200 {:$ref "#/components/responses/Response7944"}}}}},
; :components {:schemas {"Response7944" {:type "object",
; :properties {:schema {:$ref "#/components/schemas/User"}},
; :additionalProperties false,
; :required [:schema]},
; "Response7944SchemaAddress" {:type "object",
; :properties {:street {:type "string"},
; :city {:type "string", :enum (:tre :hki)}},
; :additionalProperties false,
; :required [:street :city]},
; "User" {:type "object",
; :properties {:id {:type "string"},
; :name {:type "string"},
; :address {:$ref "#/components/schemas/UserAddress"}},
; :additionalProperties false,
; :required [:id :name :address]},
; "UserAddress" {:type "object",
; :properties {:street {:type "string"}, :city {:type "string", :enum (:tre :hki)}},
; :additionalProperties false,
; :required [:street :city]}},
; :securitySchemes {},
; :responses {:Response7944 {:description "ok",
; :content {"application/json" {:schema {:$ref "#/components/schemas/Response7944"}}}}},
; :requestBodies {:User {:content {"application/json" {:schema {:$ref "#/components/schemas/User"}}}}}}}
```

producing the following ui:

Expand Down
2 changes: 1 addition & 1 deletion src/ring/swagger/openapi3.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@
transformed)
route))

(defn get-response-ref [v]
(defn get-response-ref ^String [v]
(some-> (-> v
:content
vals
Expand Down