wadl documentation viewer
CSS XSLT HTML
Latest commit 1710ee2 Jan 21, 2016 @ehearty Merge pull request #9 from gimoh/fix-schema-link-chrome
Fix weird issues with schema links in chrome

README.md

Swadl

Swagger-styled wadl documentation viewer.

This project uses xslt stylesheets to massage auto-generated wadls into human readable documentation. It was built off the efforts of:

This software is available under the MIT license, and can be used in any way you see fit.

Usage

To get started, download the project and view wadl.html in your favorite local web server. You should see something that looks like this:

http://ehearty.github.io/Swadl/wadl.html

Edit the name and location of the xmlDoc variable at the top of the header section to point to your wadl. The variable currently points to test.wadl as a working example.

Changes since release 1.0

  • I got rid of jquery and rolled my own slide transitions instead. This means that the new version might not be compatible with older browsers. If that's the case, and you're unhappy about it, download release 1.0 instead. Then feel free to shoot me an angry email at your earliest convenience.

Where does this work?

Swadl has been tested in Chrome, Safari, and Firefox. I have no way to test on IE at the moment, so I'm going to assume it doesn't work there. If anyone's out there who has acesss to a windows machine and would like to contribute to the compatibility effort, shoot me an email.

Breakdown

  • screen.css - Edit this to change the style, format, whatever...you'll probably want to change the logo :-)
  • wadl.xsl - The wadl transform stylesheet. Generates the document fragment that contains the wadl definition.
  • wadl.html - Where the magic happens. Contains javascript that should probably be moved into an official controller.
  • xsd.xsl - This file processes secondary grammar files associated with the wadl. Class definitions are injected into the document after wadl.xsl has finished processing.
  • application.wadl/ - Directory containing the grammar file associated with test.wadl. Only for test purposes.
  • test.wadl - Sample hello world wadl file with associated grammar. This wadl was generated with Jersey's extended wadl annotations (which allow you to add additional documentation to your service).

Recommendations

Swadl works best when deployed as part of your web service. Point it to the auto-generated wadl and you'll always have up-to-date documentation.

Use Jersey's extended wadl annotations. They're great, use plain vanilla javadoc, etc.

Notes

Q: How do I get rid of the search bar at the top of the page?

A: Update #header in screen.css with display:none.

Q: Nothing loads when I use the search bar?!

A: This might be due to several reasons:

  • The transform sheet wasn't able to parse the wadl that you provided. That's probably my fault, and I'd be happy to fix the bug if you let me know.
  • There might be a cross domain restriction on the page. These are a pain to address, imho, and it's why I suggest hosting Swadl on the same domain as your wadl resources.
  • The page might not be able to reach the link (maybe it's on a vpn...or you fat-fingered the url).

Q: What do I do if I find a problem?

A: Submit an issue in Git. Better yet, fork the repo, fix the bug, and send me a pull request ;-)