如何将查询参数传递给 Rails API 控制器？

Question

在我的 Ruby on Rails 应用程序中，自行车租赁公司可以管理他们所有的自行车（预订、付款等）。

上下文我想为自行车租赁公司（ shops ）提供在他们自己的网站上实施预订表格的选项，以便他们可以让客户预订bike 。

• 然后，此预订表格将显示在给定的arrival和departure日期有哪些bikes可用的bikes bike_categories 。

问题为了管理这一点，我想生成一个 API 控制器操作，显示特定bike_category的availability ，显示属于该bikes bike_category的可用bikes数量的count 。

根据这个帖子

使用一长串查询参数设计 RESTful 查询 API

我应该能够处理我的 api 中的查询，但是如何在我的 Rails 控制器中获取查询？

代码

楷模

class Shop < ApplicationRecord
  has_many :bike_categories, dependent: :destroy
  has_many :bikes, through: :bike_categories
  has_many :reservations, dependent: :destroy
end

class Reservation < ApplicationRecord
  belongs_to :shop
  belongs_to :bike
end

class Bike < ApplicationRecord
  belongs_to :bike_category
  has_many :reservations, dependent: :destroy
end

class BikeCategory < ApplicationRecord
  belongs_to :shop
  has_many :bikes, dependent: :destroy
end

路线

# api
  namespace :api, defaults: { format: :json } do
    namespace :v1 do
      resources :shops, only: [ :show ]
      resources :reservations, only: [ :show, :create ]
      resources :bike_categories, only: [:index, :show, :availability]
    end
  end

控制器/api/v1/bike_categories_controller.rb

class Api::V1::BikeCategoriesController < Api::V1::BaseController
  acts_as_token_authentication_handler_for User, only: [:show, :index, availability]

  def availability
    # How to get the bike_category, arrival and departure?
  end

end

Answer 1

Rails 在params散列中提供查询字符串参数，它实际上是以下各项的混搭：

• 请求正文（对于具有正文的 POST、PATCH、PUT 等方法）
• 查询字符串
• 路径中的命名段（例如params[:id] ）。

所以真的没什么可说的：

class Api::V1::BikeCategoriesController < Api::V1::BaseController
  acts_as_token_authentication_handler_for User, only: [:show, :index, availability]
  def availability
    # How to get the bike_category, arrival and departure?
    bike_category = params[:bike_categories] 
    arrival = params[:arrival]
    departure = params[:departure]
  end
end

但是，您的路由配置不正确。 你实际上并没有一个路线availiblity 。 only和except选项仅限制resources生成的默认 CRUD 路由的输出。 因此，有效值为：

• 展示
• 指数
• 新的
• 创建
• 编辑
• 更新
• 删除

任何其他值都没有任何影响。 如果你想添加一个额外的 RESTful 路由，你可以这样做：

resources :bike_categories, only: [:index, :show] do
  # GET .../bike_categories/:bike_category_id/availability 
  get :availability 

  # GET .../bike_categories/:id/availability 
  get :availability, on: :member

  # GET .../bike_categories/availability 
  get :availability, on: :collection
end

Answer 2

您可以使用 has_scope gem 。

里面你的自行车模型，你可以创建范围not_reserved （我假设你命名你的到达和出发的列arrive_at和departure_at ：

class Bike < ApplicationRecord
# ...
  scope :not_reserved, -> arrive, departure { left_outer_joins(:reservations).distinct.where("reservations.arrival_at < ? AND reservations.departure_at > ?", departure, arrive) }
  # If you need to return the result for a specific bike category
  scope :by_bike_category, -> bike_category_id { where(bike_category_id: bike_category_id) }
# ...
end

在您的 BikeCategoriesController 中：

class Api::V1::BikeCategoriesController < Api::V1::BaseController
  has_scope :not_reserved, using: [:arrive, :departure], type: :hash
  has_scope :by_bike_category

  def availability
    category_availability = apply_scopes(Bike).group(:bike_category_id).count

    render json: category_availability
  end

end

您的查询字符串将类似于：

?not_reserved[arrive]=20200110&not_reserved[departure]=20200125&by_bike_category=3