0.0
No commit activity in last 3 years
No release in over 3 years
The /routes route will list all of the consuming application's routes except for external redirects, generic HTTP status pages, and default Rails routes
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

~> 5.0
 Project Readme

Code ClimateTest CoverageGem Version

routes_revealer

The routes revealer is a simple engine that adds a url to your rails application that will list all of the defined routes within your application. This is especially useful if you are running in an environment where you have one website serviced by multiple backend applications.

Imagine a scenario where you have two rails applications. One is your main website and the other is a blog. You could deploy both these apps with the routes revealer gem and then setup nginx, haproxy or Netflix zuul to query these apps for their defined urls and route to the appropriate one. To your end-users it will appear as one unified website.

Installation

To install this engine follow these steps:

  1. Add the gem to your Gemfile gem 'routes_revealer'
  2. Add mount RoutesRevealer::Engine => '/' to config/routes.rb
  3. ???
  4. Profit!!

Use

Go to your application's URL at /routes and you should see all of your routes in json like so

["/assets","/","/home"]

Congratulations!