ruby - Rails 3 的 API 错误自定义，例如 Github api v3

Question

我在 Rails3 应用程序上添加了一个 API，它运行良好。但我在 http://developer.github.com/v3/ 看到了以下 Github api v3

HTTP/1.1 422 Unprocessable Entity
 Content-Length: 149

 {
   "message": "Validation Failed",
   "errors": [
     {
       "resource": "Issue",
       "field": "title",
       "code": "missing_field"
     }
   ]
 }

我喜欢错误消息结构。但无法让它重现。我怎样才能使我的 api 做出类似的响应？

Answer 1

您可以通过为您的 JSON 格式添加一个 ActionController::Responder 来轻松实现该错误格式。参见 http://api.rubyonrails.org/classes/ActionController/Responder.html对于此类的(非常模糊的)文档，但简而言之，您需要重写 to_json 方法。

在下面的示例中，我在 ActionController:Responder 中调用一个私有(private)方法，它将构建 json 响应，包括您选择的自定义错误响应；您所要做的就是填补空白，真的:

def to_json
  json, status = response_data
  render :json => json, :status => status
end

def response_data
  status = options[:status] || 200
  message = options[:notice] || ''
  data = options[:data] || []

  if data.blank? && !resource.blank?
    if has_errors?
      # Do whatever you need to your response to make this happen.
      # You'll generally just want to munge resource.errors here into the format you want.
    else
      # Do something here for other types of responses.
    end
  end

  hash_for_json = { :data => data, :message => message }

  [hash_for_json, status]
end