Personalización de errores Api para Rails 3 como Github api v3

Question

Estoy agregando una API en una aplicación Rails3 y está funcionando bastante bien. pero vi la siguiente versión 3 del API en Github http://developer.github.com/v3/

HTTP/1.1 422 Unprocessable Entity 
Content-Length: 149 

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

Me gustó la estructura de los mensajes de error. Pero no pude hacer que se reproduzca. ¿Cómo puedo hacer mi apis para que la respuesta me guste?

Answer 1

Puede lograr fácilmente ese formato de error agregando un ActionController :: Responder para su formato JSON. Consulte http://api.rubyonrails.org/classes/ActionController/Responder.html para obtener la documentación (extremadamente vaga) de esta clase, pero en pocas palabras, debe anular el método to_json.

En el siguiente ejemplo estoy llamando a un método privado en un ActionController: Respondedor que construirá la respuesta json, incluida la respuesta de error personalizada de su elección; todo lo que tienes que hacer es llenar los vacíos, realmente:

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