如何在Rails中为404响应添加自定义错误信息？

问题描述 #

控制器中已编写逻辑，当资源不存在时返回带自定义错误信息的JSON响应：

def method
  # some logic

  if something.present?
    render json: something, serializer: SomeSerializer
  else
    render json: { errors: I18n.t('errors.something.no_something') }, status: :not_found
  end
end

但通过Postman请求时，仅显示项目默认的404页面，无法获取自定义JSON错误信息。

解决方案 #

1. 确保请求指定JSON格式 #

Rails会根据请求的Accept头或URL后缀决定响应格式：

• 在Postman请求头中添加Accept: application/json
• 或者在请求URL末尾追加.json（如/api/resource.json）

2. 强制指定响应格式 #

在render语句中显式指定format: :json，确保无论请求头如何，都返回JSON格式响应：

render json: { errors: I18n.t('errors.something.no_something') }, status: :not_found, format: :json

3. 检查Rails异常处理配置 #

如果项目配置了全局异常路由（如config/application.rb中设置config.exceptions_app = self.routes），需确保路由中针对JSON请求的404处理逻辑正确：

• 在config/routes.rb中添加API专属的异常路由：

  namespace :api do
    match '*path', to: 'errors#not_found', via: :all, defaults: { format: :json }
  end
  

  然后在Api::ErrorsController中实现not_found方法，返回自定义JSON错误。

4. 排查全局拦截逻辑 #

检查是否存在全局before_action或其他拦截器，在主动render之前触发了跳转或默认404页面渲染，导致自定义响应被覆盖。

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