需要在Rails中返回JSON格式的404错误

Question

我的Rails应用程序中有一个正常的HTML前端和一个JSON API。现在，如果有人拨打/api/not_existent_method.json，它将返回默认的HTML 404页面。有什么方法可以将此改为{"error": "not_found"}之类的东西，同时保留HTML前端的原始404页面完好吗？

Answer 1

一个朋友指出我朝着优雅的解决方案，它不仅可以处理404也是500错误。事实上，它处理每一个错误。关键是，每一个错误都会产生一个异常，通过一堆机架中间件向上传播，直到它们中的一个被处理。如果你有兴趣了解更多，你可以看this excellent screencast。 Rails拥有自己的异常处理程序，但您可以通过配置文件exceptions_app配置选项覆盖它们。现在，你可以写你自己的中间件，或者你可以路由错误回到轨道，就像这样：

# In your config/application.rb 
config.exceptions_app = self.routes 

然后你只需要这些路线在您的config/routes.rb匹配：

get "/404" => "errors#not_found" 
get "/500" => "errors#exception" 

然后你只需创建一个控制器来处理这个。

class ErrorsController < ActionController::Base 
    def not_found 
    if env["REQUEST_PATH"] =~ /^\/api/ 
     render :json => {:error => "not-found"}.to_json, :status => 404 
    else 
     render :text => "404 Not found", :status => 404 # You can render your own template here 
    end 
    end 

    def exception 
    if env["REQUEST_PATH"] =~ /^\/api/ 
     render :json => {:error => "internal-server-error"}.to_json, :status => 500 
    else 
     render :text => "500 Internal Server Error", :status => 500 # You can render your own template here 
    end 
    end 
end 

要添加的最后一件事：在开发环境中，rails通常不呈现404或500页，而是打印回溯。如果您想在开发模式下看到您的ErrorsController正在运行，请在config/enviroments/development.rb文件中禁用回溯功能。

config.consider_all_requests_local = false 

Answer 2

当然，这将是这个样子：

class ApplicationController < ActionController::Base 
    rescue_from NotFoundException, :with => :not_found 
    ... 

    def not_found 
    respond_to do |format| 
     format.html { render :file => File.join(Rails.root, 'public', '404.html') } 
     format.json { render :text => '{"error": "not_found"}' } 
    end 
    end 
end 

NotFoundException是不异常的真实姓名。它会随着Rails版本和你想要的确切行为而变化。使用Google搜索很容易找到。

Answer 3

尝试把你routes.rb结束：

match '*foo', :format => true, :constraints => {:format => :json}, :to => lambda {|env| [404, {}, ['{"error": "not_found"}']] } 

Answer 4

我喜欢创建一个单独的API控制器，其设置格式（JSON）和特定的API的方法：

class ApiController < ApplicationController 
    respond_to :json 

    rescue_from ActiveRecord::RecordNotFound, with: :not_found 
    # Use Mongoid::Errors::DocumentNotFound with mongoid 

    def not_found 
    respond_with '{"error": "not_found"}', status: :not_found 
    end 
end 

RSpec的测试：

it 'should return 404' do 
    get "/api/route/specific/to/your/app/", format: :json 
    expect(response.status).to eq(404) 
    end