需要在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