ring.swagger.swagger-ui

Liking cljdoc? Tell your friends :D

Clojure only.

conf-js
config-json
get-path
swagger-ui
wrap-swagger-ui

conf-js^clj

(conf-js req opts)

source

config-json^clj

(config-json req opts)

source

get-path^clj

(get-path root uri)

source

swagger-ui^clj

(swagger-ui)

(swagger-ui options)

Returns a (async-)ring handler which can be used to serve swagger-ui. Takes the following options:

:path the root path for the swagger-ui, Defaults to "/"
:root the root prefix to get resources from. Default 'swagger-ui'
:swagger-docs the endpoint to get swagger data from. Default '/swagger.json'
:oauth2 map with oauth2 params, namely :client-id, :realm and :app-name
Other options are passed as is to SwaggerUi constructor. Map keys are renamed to camelCase.

Returns a (async-)ring handler which can be used to serve swagger-ui.
Takes the following options:

- **:path**         the root path for the swagger-ui, Defaults to "/"
- **:root**         the root prefix to get resources from. Default 'swagger-ui'
- **:swagger-docs** the endpoint to get swagger data from. Default '/swagger.json'
- **:oauth2**       map with oauth2 params, namely `:client-id`, `:realm` and `:app-name`
- Other options are passed as is to SwaggerUi constructor. Map keys are
renamed to camelCase.

source raw docstring