Потрібно повернути помилку 404 у форматі JSON у Rails

У мене є звичайний інтерфейс HTML та API JSON у моєму додатку Rails. Тепер, якщо хтось зателефонує, /api/not_existent_method.jsonвін повертає сторінку HTML 404 за замовчуванням. Чи є спосіб змінити це на щось подібне {"error": "not_found"}, залишаючи непорушною оригінальну сторінку 404 для інтерфейсу HTML?

Друг вказав мені на елегантне рішення, яке не лише обробляє 404, а й 500 помилок. Насправді він обробляє кожну помилку. Ключовим є те, що кожна помилка генерує виняток, який поширюється вгору через стек проміжних засобів стійки, доки її не обробить одна з них. Якщо вам цікаво дізнатись більше, ви можете переглянути цей чудовий скринкаст . У 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

Мені подобається створювати окремий контролер 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

Звичайно, це буде виглядати приблизно так:

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.

Спробуйте поставити в кінці з ваших routes.rb:

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