为什么尝试在Rails中使用Grape失败，并带有“未初始化的常量API”？

Question

我希望有人解释为什么在Grape（0.10.1）的Rails（4.1.8）中会发生这种情况

所以这是我的API：

app/api/root.rb：

module API
  class Root < Grape::API
    prefix 'api'
    mount API::V1::Root
  end
end

app/api/v1/root.rb：

module API::V1
  class Root < Grape::API
    version 'v1'
    mount API::V1::Users
  end
end

app/api/v1/users.rb：

module API::V1
  class Users < Grape::API
    format 'json'

    resource :users do
      desc "Return list of users"
      get '/' do
        User.all
      end
    end
  end
end

config/routes.rb：

Rails.application.routes.draw do
  mount API::Root => '/'
end

并且在我的application.rb中添加：

config.paths.add "app/api", glob: "**/*.rb"
config.autoload_paths += Dir["#{Rails.root}/app/api/*"]

并且在这种情况下，我得到了错误：NameError: uninitialized constant API

---

但是如果我的代码看起来像：

app/api/root.rb与上述相同

然后app/api/v1/root.rb：

class Root < Grape::API
  version 'v1'
  mount Users
end

app/api/v1/users.rb：

class Users < Grape::API
  format 'json'

  resource :users do
    desc "Return list of users"
    get '/' do
      User.all
    end
  end
end

config/routes.rb：

Rails.application.routes.draw do
  mount Root => '/'
end

和config/application.rb与上面相同

然后一切正常。

我的问题是，为什么我不需要在v1/root.rb内以及v1/users内都指定模块，为什么我不需要在API::Root => '/'中使用config/routes.rb？

Answer 1

因为app/api是API类的顶层文件夹，而不是app。

来自Grape's documentation：

将API文件放入app/api。 Rails需要一个与Ruby模块名称匹配的子目录，以及一个与类名称匹配的文件名。在我们的示例中，Twitter::API的文件名位置和目录应为app/api/twitter/api.rb。

因此，API::Root类的正确位置实际上是app/api/api/root.rb，而不是/app/api/root.rb-尽管is顶级命名空间中类的正确位置，这就是第二个示例的原因您给予（从API模块中删除的类）的作品。

不过，我建议您将API类放在各自的模块中，然后将它们移到app/api下的匹配子文件夹中。

Answer 2

我试图将文件放入app/api/api，但对我来说不起作用。

我通过简单地将api文件夹放入controller文件夹找到了解决方案。我不是100％知道问题出在哪里，但是我猜想这与自动加载的路径有关。

Answer 3

来自Grape's documentation：

对于大于6.0.0.beta2的Rails版本，Zeitwerk自动装载器是CRuby的默认值。默认情况下，Zeitwerk将api改写为Api，而不是API。为了使我们的示例生效，您需要取消注释config/initializers/inflections.rb底部的行，并添加API作为首字母缩写：

ActiveSupport::Inflector.inflections(:en) do |inflect|
  inflect.acronym 'API'
end