route-swagger.doc — oliyh/route-swagger 0.1.6

annotate clj

(annotate doc obj)

Inputs: [doc :- spec/Operation obj]

Attaches swagger documentation to an object

annotation clj

Gets documentation from an annotated object

paths clj

(paths route-table)

Inputs: [route-table] Returns: SwaggerPaths

Generates swagger paths from an expanded route table. This function can also be used to generate documentation offline or for easy debugging (turning schema checks on).

SwaggerPaths clj

with-swagger clj

(with-swagger route-table)

(with-swagger route-table docs)

Attaches swagger information as a meta key to each documented route. The context passed to each interceptor has a reference to the selected route, so information like request and response schemas and the swagger object can be retrieved from its meta.