将 ActiveRecord 验证错误转换为 API 可使用错误

我正在 Rails 4 中编写一个非常标准的 CRUD RESTful API。不过，我在错误处理方面有所欠缺。

假设我有以下模型：

class Book < ActiveRecord::Base
  validates :title, presence: true
end

如果我尝试创建没有标题的书籍对象，我将收到以下错误：

{
  "title": [
    "can't be blank"
  ]
}

ActiveRecord 验证旨在与表单一起使用。理想情况下，我希望将每个人类可读的验证错误与 API 使用者可以使用的常量进行匹配。所以像这样：

{
  "title": [
    "can't be blank"
  ],
  "error_code": "TITLE_ERROR"
}

这都可以用于显示用户面临的错误（“标题不能为空”）并且可以在其他代码中使用（if response.error_code === TITLE_ERROR...）。 Rails 中是否有任何工具可以实现此目的？

编辑：这是一个Rails 2 天提出的非常相似的问题 https://stackoverflow.com/questions/8933864/pattern-for-translating-activerecord-validation-errors-to-api-responses.

On 错误代码.yml定义您的标准 API 错误，包括status_code, title, details和一个内部code然后，您可以在 API 文档中提供有关错误的更多信息。

这是一个基本示例：

api:
  invalid_resource:
    code: '1'
    status: '400'
    title: 'Bad Request'

not_found:
    code: '2'
    status: '404'
    title: 'Not Found'
    details: 'Resource not found.'

On 配置/初始化器/api_errors.rb将该 YAML 文件加载到常量中。

API_ERRORS = YAML.load_file(Rails.root.join('doc','error-codes.yml'))['api']

On 应用程序/控制器/关注点/error_handling.rb定义一个可重用的方法来以 JSON 格式呈现 API 错误：

module ErrorHandling
  def respond_with_error(error, invalid_resource = nil)
    error = API_ERRORS[error]
    error['details'] = invalid_resource.errors.full_messages if invalid_resource
    render json: error, status: error['status']
  end
end

在您的 API 基础控制器上包含关注点，以便它在继承它的所有控制器上可用：

include ErrorHandling

然后，您将能够在任何这些控制器上使用您的方法：

respond_with_error('not_found') # For standard API errors
respond_with_error('invalid_resource', @user) # For invalid resources

例如，在您的用户控制器上，您可能有以下内容：

def create
  if @user.save(your_api_params)
    # Do whatever your API needs to do
  else
    respond_with_error('invalid_resource', @user)
  end
end

您的 API 将输出的错误将如下所示：

# For invalid resources
{
  "code": "1",
  "status": "400",
  "title": "Bad Request",
  "details": [
    "Email format is incorrect"
  ]
}

# For standard API errors
{
  "code": "2",
  "status": "404",
  "title": "Not Found",
  "details": "Route not found."
}

随着 API 的增长，您将能够轻松地在 YAML 文件中添加新的错误代码，并通过此方法使用它们，从而避免重复并使错误代码在整个 API 中保持一致。