Rails 4 - 只响应JSON而不是HTML

Question

我试图在rails 4中构建一个API，并且在使用respond_to :json并尝试访问html版本时，导致rails返回500错误而不是406的问题。

这里有一个例子控制器，展示了这个问题：

class PostsController < ApplicationController 
    respond_to :json 

    def index 
    @posts = Post.all 
    end 
end 

我也有一个index JBuilder的视图通过JSON访问时的作品。如果我尝试访问没有JSON扩展名的路由，它会尝试加载HTML模板（不存在）并返回500错误，而不是仅呈现JSON或返回406错误。

这可能是什么原因造成的？欢呼任何帮助。

Answer 1

由于您使用的是before_filter，如果未定义格式的请求，您将有406不可接受。

实施例：

class SomeController < ApplicationController 
    respond_to :json 


    def show 
    @record = Record.find params[:id] 

    respond_with @record 
    end 
end 

另一种方法是添加一个的before_filter检查的格式并相应地作出反应。

例子：

class ApplicationController < ActionController::Base 
    before_filter :check_format 


    def check_format 
    render :nothing => true, :status => 406 unless params[:format] == 'json' 
    end 
end 

但我认为，你可以做到这一点：

respond_to do |format| 
    format.json { render :json => @posts } 
end 

进一步的信息： http://guides.rubyonrails.org/layouts_and_rendering.html

Answer 2

为了避免加载不存在的HTML模板，设置默认资源类型为config/routes.rb中的JSON：

resources :posts, :defaults => { :format => :json } 

Answer 3

我相信，有2个部分的位置：
1）仅适用于JSON 请求在轨
2）仅适用于JSON 回复在轨

1）配置应用程序控制器，以确保JSON请求仅

# app/controller/application_controller.rb 
before_action :ensure_json_request 

def ensure_json_request 
    return if request.format == :json 
    render :nothing => true, :status => 406 
end 

2）配置你的Rails API的路线，以确保JSON响应只有

# config/routes.rb 
MyApp::Application.routes.draw do 
    namespace :api, constraints: { format: 'json' } do 
    namespace :v1 do 
     resources :posts 
    end 
    end 
end 

Answer 4

您可以通过过滤器，明确提出要求，以JSON之前有设置。

request.format = :json

Answer 5

你可以试试这个，因为我也面临这样的问题，现在它是通过使用该解决方案来解决。

class PostsController < ApplicationController 
    respond_to :json 

    def index 
    @posts = Post.all 
    render json: @posts 
    end 
end 

Answer 6

当您在JSON尝试响应

是怎么一回事，因为你只需要一些属性，我用这个

@my_model=Model.select(:attributeN, :attributeN......, attributeN) 
respond_to do |format| 
    format.json { 
    render json: @my_model 
    } 
end 

Answer 7

我建议你去尝试gem 'active_model_serializers'。它真的很棒，并保持清洁。

的ApplicationController：

class ApplicationController < ActionController::Base 
    protect_from_forgery with: :exception, if: Proc.new { |c| c.request.format != 'application/json' } 
    protect_from_forgery with: :null_session, if: Proc.new { |c| c.request.format == 'application/json' } 
end 

途径：

namespace :api, defaults: { format: :json } do 
    resource :posts 
end 

帖子控制器：

def index 
    render json: Post.all 
end 

Answer 8

在导轨4，您需要传递一个lambda来强制执行路由上的约束。

不幸的是，这是行不通的，因为它仍然会尝试投放（或者试图成为了）的HTML模板，因为该格式是一个可选的参数：

resources :posts, constraints: { format: 'json' } 

这不工作（使用拉姆达）：

resources :posts, constraints: lambda { |req| req.format == :json } 

请参阅this section of the Rails guide中的第二个（最终）注释。

Answer 9

constraints不适用于POST请求，然后我尝试defaults它适用于所有。

namespace :api, :defaults => { :format => 'json' } do 
    namespace :v1 do 
     resources :users do 
     collection do 
      get 'profile' 
     end 
     end 
     post 'signup' => 'users#create' 
     post 'login' => 'user_sessions#create' 
    end 
end