swag.model documentation

Swagger model related functionality

add-model

(add-model k m)
Adds a model (used internaly)

conversions

applied conversion path -> fn

convert

(convert uri params)
Process a list of params running registered conversions
registered conversions use base-uri -> conversion mappings:
 /foo/1 base uri is /foo 

defc

macro

(defc uri path f)
Defines a model conversion v (value) passed implicitly.

defmodel

macro

(defmodel name & props)
Defining a swagger model: 
(defmodel module :name :string :src :string) 

model

model-

(model- & k__187__auto__)

models

User defined types

nest-types

(nest-types m)
Taks type :foo and nests in {:type :foo}

wrap-swag

(wrap-swag app)
A ring middleware that utilizes swagger metadata on passed in requests, it runs validations and conversions according to ones defined using swag.model