Rails 7中如何声明多个嵌套的必填请求参数？

问题背景 #

接收外部API请求的JSON示例：

{
  "sdd_request": {
    "return_url": "https://example.com/return",
    "data": {
      "debit_method": "CORE",
      "debtor": {
        "name": "John Doe",
        "email": "john.doe@example.com"
      }
    },
    "extension": {
      "signees": [{"email": "test@test.com", "name": "joe", "last_name": "smith" }],
      "creditor": {
        "id": "12345",
        "name": "Acme Inc.",
        "address": {
          "city": "New York"
        }
      }
    }
  }
}

必填参数列表：

• return_url
• data
• signees
• creditor

当前实现代码：

def sdd_setup_request_params
  params.require(:sdd_request).permit(
    :return_url,
    data: [
      :debit_method,
      debtor: [
        :name,
        :email
      ]
    ],
    extension: [
      signees: [],
      creditor: [
        :id,
        :name,
        address: [
          :city
        ]
      ]
    ]
  )
end

当前问题：上述代码仅要求了顶级的sdd_request参数，嵌套的必填字段（如extension下的signees、creditor）缺失时，不会触发参数缺失的错误，无法满足验证需求。

解决方案 #

要验证嵌套的必填参数，需要逐层对必填字段调用require方法，确保每个必填层级都存在，之后再用permit允许合法字段。修正后的代码如下：

def sdd_setup_request_params
  # 获取并要求顶级的sdd_request参数
  sdd_request_params = params.require(:sdd_request)

  # 验证顶级必填字段
  sdd_request_params.require(:return_url)
  sdd_request_params.require(:data)
  extension_params = sdd_request_params.require(:extension)

  # 验证extension下的嵌套必填字段
  extension_params.require(:signees)
  extension_params.require(:creditor)

  # 允许所有合法参数字段
  sdd_request_params.permit(
    :return_url,
    data: [
      :debit_method,
      debtor: [
        :name,
        :email
      ]
    ],
    extension: [
      signees: [:email, :name, :last_name], # 明确指定允许的数组字段，替代空数组更安全
      creditor: [
        :id,
        :name,
        address: [
          :city
        ]
      ]
    ]
  )
end

关键说明 #

1. 逐层验证必填项：通过分步调用require，确保每个必填的层级和字段都存在，只要有一个缺失，Rails会自动抛出ActionController::ParameterMissing异常。
2. 明确允许数组字段：原代码中signees: []会允许数组内任意属性，建议明确指定允许的字段，符合强参数的安全原则，避免接收冗余数据。
3. 自定义错误响应（可选）：如果需要统一错误格式，可以在控制器中捕获异常并返回自定义响应：

rescue_from ActionController::ParameterMissing do |e|
  render json: { error: "缺失必填参数: #{e.param}" }, status: :bad_request
end

内容的提问来源于stack exchange，提问作者tajfun_88