Skip to content
Swagger integration for Pedestal and Tripod
Clojure
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
src/route_swagger
test/route_swagger
.gitignore Route swagger Jan 29, 2016
CHANGELOG.md
LICENSE.md
README.md Update README.md Dec 9, 2016
boot.properties
build.boot
circle.yml
project.clj

README.md

route-swagger

Build status

Generate Swagger documentation from pedestal (or tripod) routes

For old pedestal-swagger users

This project now focuses solely on route transformation and schema validation and thus is pedestal-agnostic.

Route-swagger is a much lower level library. Everything the old pedestal-swagger did is still possible (look at the example repo) but requires a bit more boilerplate. The major breaking difference is that now route-swagger uses ring specific keys for describing the schema rather than swagger ones, e.g.

{:parameters {:body-params ..
              :form-params ..
              :query-params ..
              :path-params ..
              :headers ..}
  :responses {500 {:body .. :headers ..}}}            

Instead of body, formData, query, schema, etc. That should make it much more user friendly for clojure users.

For a nicer integration with pedestal, extra features and easier migration path from the old pedestal-swagger check out pedestal-api.

Download

Clojars Project

Usage

Have a look at the project under the example folder for a working pedestal app

License

Copyright © 2015 Frankie Sardo

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.

You can’t perform that action at this time.