Question

我正在Grape中编写一个API，但它独立，没有Rails或Sinatra或任何东西。我想将app.rb文件拆分为单独的文件。我查看了How to split things up in a grape api app?，但这与Rails有关。

我不确定如何使用模块或类来完成这项工作 - 我尝试将不同的文件子类化为我的大GrapeApp，但这很难看，我甚至不确定它是否正常工作。最好的方法是什么？

我目前有按文件夹（v1，v2等）分割的版本，但这就是全部。

Answer 1

您不需要从主应用程序中进行子类化，您只需在主要应用程序中安装单独的Grape :: API子类。当然，您可以在单独的文件中定义这些类，并使用require加载您应用可能需要的所有路由，实体和帮助程序。我发现每个“域对象”创建一个迷你应用程序很有用，并加载app.rb中的那些，如下所示：

  # I put the big list of requires in another file . . 
  require 'base_requires'

  class MyApp < Grape::API
    prefix      'api'
    version     'v2'
    format      :json

    # Helpers are modules which can have their own files of course
    helpers APIAuthorisation

    # Each of these routes deals with a particular sort of API object
    group( :foo ) { mount APIRoutes::Foo }
    group( :bar ) { mount APIRoutes::Bar }
  end

我在文件夹中安排文件，相当随意：

# Each file here defines a subclass of Grape::API
/routes/foo.rb 

# Each file here defines a subclass of Grape::Entity
/entities/foo.rb

# Files here marshal together functions from gems, the model and elsewhere for easy use
/helpers/authorise.rb

我可能会模拟Rails并拥有一个/models/文件夹或类似文件来保存ActiveRecord或DataMapper定义，但是在我当前项目中以不同的模式为我提供了它。

我的大多数路线看起来非常基本，它们只是调用相关的辅助方法，然后基于它呈现实体。例如。 /routes/foo.rb可能如下所示：

module APIRoutes
  class Foo < Grape::API
    helpers APIFooHelpers

    get :all do
      present get_all_users_foos, :with => APIEntity::Foo
    end

    group "id/:id" do
      before do
        @foo = Model::Foo.first( :id => params[:id] )
        error_if_cannot_access! @foo
      end

      get do
        present @foo, :with => APIEntity::Foo, :type => :full
      end

      put do
        update_foo( @foo, params )
        present @foo, :with => APIEntity::Foo, :type => :full
      end

      delete do
        delete_foo @foo
        true
      end
    end # group "id/:id"
  end # class Foo
end # module APIRoutes

将Grape API（非Rails）拆分为不同的文件

1 个答案: