See a “pretty” version of your API.
Goggles installs a little tiny Sinatra app on a URL prefix and serves any JSON responses that come back as a prettyprinted HTML page. There are browser add-ons that do a great job with this sort of thing, but I wanted something I could live-link from API docs.
This could be a lot fancier and prettier, I just extracted the bare minimum from a production app. Patches welcome.
require "rack/goggles" use Rack::Goggles, "/goggles"
Let's pretend your app has a users resource available at http://example.org/api/v3/users. With Goggles configured as above, hitting http://example.org/goggles/api/v3/users will give you a prettified version.
Goggles ignores any response that doesn't have an application/json content type.
$ gem install rack-goggles
Copyright 2010 John Barnette (email@example.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Goggles uses a modified version of James Padolsey's prettyPrint.js (github.com/jamespadolsey/prettyPrint). Thanks, James!