Clone this wiki locally
Vasco is a simple UI for exploring the RESTful routes configured for your application. To install the plugin (using Rails later than July 14, 2008):
> script/plugin install git://github.com/relevance/vasco.git
If using an older version of Rails:
> cd vendor/rails
> git clone git://github.com/relevance/vasco.git
> rm -rf vasco/.git
> cd ../..
> require ‘vendor/plugins/vasco/install’
After installation, the plugin will create a folder in your application’s /public directory called vasco. Before you can use the UI, you have to seed it with your application’s current data. (It helps if you run rake db:fixtures:load first so that Vasco can suggest IDs for you.)
> rake vasco:explore
To use the route explorer, start up your application and point your browser to:
From here, you will be provided with links to all registered RESTful routes. You can perform GETs, POSTs, PUTs and DELETEs. The UI will know not only the routes, but the schema for each model in your application. If there is a standard Rails configuration linking a controller to a model, the UI will present you with a form you can use to fill out model details for POSTs and PUTs, and will even provide default IDs if you have seeded the database with fixture data already.
Feature Wish List
Here’s what’s on our upcoming feature list:
- actual support for nested routes. Currently, they appear in the list, but you can’t navigate to them.
- support for multiple MIME types. Currently, the system only uses the XML endpoints.
- fixing the remaining UI glitches (expanded URLs overrunning the edge of the left container, for example)
- switching to a faster, lighter lightbox implementation
Copyright © 2008 Relevance, Inc., released under the MIT license