swag.core documentation
Swagger integration for Compojure, see https://github.com/wordnik/swagger-core/wiki/Resource-Listing for api definitions.
DELETE-
macro
(DELETE- path args desc & body)
A swagger enabled DELETE route.
GET-
macro
(GET- path args desc & body)
A swagger enabled GET route.
POST-
macro
(POST- path args desc & body)
A swagger enabled POST route.
PUT-
macro
(PUT- path args desc & body)
A swagger enabled PUT route.
api-
(api- & k__187__auto__)
api-decleration-
(api-decleration- & k__187__auto__)
api-declerations
(api-declerations)
generates api decleration routes
bare-api-
(bare-api- & k__187__auto__)
combine-apis
(combine-apis _apis)
containers
see https://github.com/wordnik/swagger-core/wiki/Datatypes
create-api
(create-api _name & routes)
Creates the api route
create-op
(create-op desc verb params)
Creates an operation
create-params
(create-params path args)
Creates the parameter list for a given path out of provided args
defroutes-
macro
(defroutes- name & routes)
A swagger enabled defroute
error-
(error- & k__187__auto__)
errors
(errors es)
A map of errors to swagger errors
guess-type
(guess-type path arg)
Detects param type (both http and object type).
http-codes
see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
listing
(listing version)
The swagger api listing (api-docs.json).
operation-
(operation- & k__187__auto__)
parameter-
(parameter- & k__187__auto__)
primitives
see https://github.com/wordnik/swagger-core/wiki/Datatypes
property-
(property- & k__187__auto__)
resource-listing-
(resource-listing- & k__187__auto__)
set-base
(set-base b)
Sets API base path
swag-path
(swag-path path)
swag-verb
macro
(swag-verb verb path args desc & body)
Creates a swagger enabled http route with a given verb
swagger-routes
(swagger-routes version)
The swagger-routes ready to be include into a compojure app
type-match
(type-match m)
Matches a given type agains primitives containers and custom defined types