Action\_Args 项目技术文档

1. 安装指南

要使用 action_args 项目，首先需要将其添加到您的 Rails 应用的 Gemfile 中：

gem 'action_args'

接着，运行以下命令来安装该 gem：

bundle install

确保你的应用使用的 Ruby 和 Rails 版本与 action_args 支持的版本兼容。

2. 项目的使用说明

action_args 是一个 Rails 插件，允许你在控制器动作方法中指定感兴趣的参数。这使得你的 Rails 控制器行为类似于 Merb。

例如，假设你有以下控制器代码：

class UsersController < ApplicationController
  def show(id)
    @user = User.find id
  end
end

当请求访问 /users/777 时，它将调用 UsersController#show 方法，传递 777 作为方法参数。

3. 项目 API 使用文档

方法参数类型

必须参数（:req）

指定的方法参数是必须的。如果 params 哈希中没有相同名称的键，将抛出 ActionContrller::BadRequest。

class UsersController < ApplicationController
  # `id` 参数是必须的
  def show(id)
    @user = User.find id
  end
end

可选参数（:opt）

默认参数值按标准方式分配。带有默认值的参数不需要 params 哈希中有匹配项。

class UsersController < ApplicationController
  # `page` 参数是可选的
  def index(page = nil)
    @users = User.page(page).per(50)
  end
end

关键字参数（:key）

如果你认为 Ruby 2.0 语法更易读，可以选择这种样式来定义你的动作方法。这与 :opt 的工作方式相同。

class UsersController < ApplicationController
  # `page` 参数是可选的
  def index(page: nil)
    @users = User.page(page).per(50)
  end
end

必须关键字参数（:keyreq）

:keyreq 是 :key 的必须版本，自 Ruby 2.1 引入。你可以使用这种语法替代 :req。

class CommentsController < ApplicationController
  def create(post_id:, comment:)
    post = Post.find post_id
    if post.create comment
      ...
    end
  end
end

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。简要概括，你需要将 action_args 添加到你的 Gemfile 中，并运行 bundle install 命令。请确保你的环境满足项目支持的 Ruby 和 Rails 版本要求。