com.zimpler.routedocs.core — com.zimpler/routedocs 0.1.0

ANY+ clj macro

(ANY+ path args doc & body)

context+ clj macro

(context+ path args doc & routes)

DELETE+ clj macro

(DELETE+ path args doc & body)

GET+ clj macro

(GET+ path args doc & body)

HEAD+ clj macro

(HEAD+ path args doc & body)

OPTIONS+ clj macro

(OPTIONS+ path args doc & body)

PATCH+ clj macro

(PATCH+ path args doc & body)

POST+ clj macro

(POST+ path args doc & body)

PUT+ clj macro

(PUT+ path args doc & body)

reset-routedocs! clj macro

(reset-routedocs!)

Must be inserted at beginning of file containing main route macros. If not inserted, then an error message will be written to stderr, and an exception thrown for every call to one of the <route>+ macros.

wrap-routedocs clj

(wrap-routedocs handler & {:keys [path] :or {path "/routedocs"} :as ops})

Standard ring middleware which serves routedocs as Markdown or HTML at ':path' ':path' default to '/routedocs' Examples: (wrap-routedocs) (wrap-routedocs :path "/some/path/for/docs")

write-routedocs! clj macro

(write-routedocs! file)

Writes your routedocs as Markdown to the specified file. 'file' maybe a String or java.io.File. Must be inserted at end of file containing main route macros. (If not inserted, then no docs are written to file.)