Exposing the set of rack routes built by Grape

[dblock]

Grape APIs can now be inspected. It now exposes an array of API versions and an array of compiled routes. Each route contains a prefix, version, namespace, method and path.

This allows to build dynamic documentation and stuff like that. The possibilities are endless, the world is ours!

    class TwitterAPI < Grape::API      

      version 'v1'
      get "version" do 
        api.version
      end

      version 'v2'
      namespace "ns" do
        get "version" do
          api.version
        end
      end      

    end

    TwitterAPI::versions # yields [ 'v1', 'v2' ]
    TwitterAPI::routes # yields an array of Grape::Route objects

You can store additional information with routes and inspect it.

[mbleigh]

OK, feel free to go ahead and make this happen (it can't be auto-merged).

[pboling]

What happened to the routes method? Is there a current way to accomplish this? Current grape gives me:

undefined methodroutes' for #Rack::Builder:0x0000010c471d70"` when I try to get the routes.

[dblock]

It should be working just fine, but it's a class method on the API.

~/source/grape-on-rails/dblock (master)$ rails c
Acme::Ping.routes
Loading development environment (Rails 4.1.4)
2.0.0-p353 :001 > Acme::Ping.routes
 => [#<Grape::Route:0x007fef55fb72e0 @options={:description=>"Returns pong.", :prefix=>"api", :version=>nil, :namespace=>"/", :method=>"GET", :path=>"/api/ping(.:format)", :params=>{}, :compiled=>/\A\/api\/ping(?:\.(?<format>[^\/.?]+))?\Z/}>] 

[pboling]

Hmmm... perhaps it only works when grape is mounted in Rails 4? We are on Rails 3.2.18:

$ rails c
> TrumakerAPI::Root.routes
NoMethodError: undefined method `routes' for #<Rack::Builder:0x000001063b06a8>
> TrumakerAPI::Root.class
=> Rack::Builder

[pboling]

I think the fact that my Grape API class is not a Grape related thing might be the problem.

> TrumakerAPI::Root.class.ancestors
=> [Rack::Builder,
 Object,
 Looksee::ObjectMixin,
 ORI::Extensions::Object,
 Debugging,
 MethodLocator,
 EveryDayIrb,
 InteractiveEditor::Editors,
 FileUtils::Verbose,
 FileUtils,
 FileUtils::StreamUtils_,
 ActionDispatch::TestProcess,
 Metaclass::ObjectMethods,
 Mocha::ObjectMethods,
 PP::ObjectMixin,
 Nori::CoreExt::Object,
 ERB::Util,
 AttrEncryptor::InstanceMethods,
 JSON::Ext::Generator::GeneratorMethods::Object,
 ActiveSupport::Dependencies::Loadable,
 Kernel,
 BasicObject]

[pboling]

Nevermind, thanks for rubber ducking.

For future googlers, I have this setup:

definition of the class is like this:

module TrumakerAPI
  class Dispatch < Grape::API
    # blah blah
  end

  # Insert the logging app into the middleware stack
  Root = Rack::Builder.new do
    use TrumakerAPI::Logger
    run TrumakerAPI::Dispatch
  end
end

So Root, is what I mount in my app... but Grape is buried inside it.

Trumaker::Application.routes.draw do # |map|
  mount TrumakerAPI::Root => '/kthxbye'

And this does work:

> TrumakerAPI::Dispatch.routes
=> All my goodies.

[dblock]

👍