duckula.swagger — nomnom/duckula 0.8.0

Provides a Ring middleware which can serve swagger.json generated from the API config as well as Swagger UI to view it. Note that we're ignoring reflection warnings as they don't matter in dev mode, and in production all schemas are (should be) parsed only once.

build-handler clj

(build-handler config)

Returns a Ring handler which returns auto-generated swagger json, based on the Duckula config

config->swagger clj

(config->swagger {:keys [name prefix endpoints] :as config})

endpoint->swagger clj

(endpoint->swagger path config)

error-schemas clj

generate clj

(generate config)

make-definition clj

(make-definition {:keys [avro-schema path mangle-names?]})

make-schema-name clj

(make-schema-name req-schema-path)

swagger-json-path clj

swagger-ui-handler clj

ui-prefix clj

with-docs clj

(with-docs api-config)

Builds a Ring handler - just like reqular duckula.handler but also attaches the following routes (by default): /~docs/ui - to load the bundled Swagger UI /~docs/swagger.json - to return swagger.json built from Duckula config