Rails配置JBuilder后仍返回HTML而非JSON的问题排查

我来帮你排查这个问题——明明已经创建了show.json.jbuilder，但JSON请求还是返回HTML，大概率是模板匹配、配置或者缓存的问题，咱们一步步来解决：

1. 先确认视图文件的基础信息 #

首先一定要检查你的JBuilder文件是否完全符合Rails的要求：

• 路径必须是app/views/posts/show.json.jbuilder，和控制器PostsController的show动作对应，文件夹名posts要和控制器复数名一致
• 文件名必须是show.json.jbuilder，注意后缀顺序是.json.jbuilder，不能写反成.jbuilder.json，也不能有拼写错误（比如把jbuilder写错）

2. 修正respond_to的用法 #

你之前尝试的respond_to :json, :html是简写，但有时候Rails的自动模板查找会出现异常，建议回到完整的respond_to块并明确指定渲染逻辑，这样能确保请求格式和模板的对应：

def show
  @post = Post.find(1)
  respond_to do |format|
    format.html # 自动渲染app/views/posts/show.html.erb
    format.json { render template: 'posts/show.json.jbuilder' } # 明确指定JBuilder模板
  end
end

测试一下这个写法，如果能正常返回JSON，说明之前的自动匹配逻辑出了问题，这个显式指定的方式可以作为临时解决，也能帮你定位问题。

3. 检查MIME类型配置 #

默认情况下Rails已经注册了JSON的MIME类型，但如果你的项目被修改过配置，可能出现问题：
打开config/initializers/mime_types.rb，确认存在这一行（没有的话加上）：

Mime::Type.register "application/json", :json

修改后记得重启Rails服务器。

4. 清除Rails缓存 #

开发环境下Rails可能会缓存模板查找结果，导致新创建的JBuilder文件不被识别，执行以下命令清除缓存：

rails tmp:clear

然后重启服务器，再测试localhost:3000/posts/1.json。

5. 验证路由匹配 #

运行rails routes命令，查看posts#show对应的路由条目，确认存在类似这样的行：

GET    /posts/:id(.:format)    posts#show

这里的(.:format)表示路由支持格式参数，确保你的posts/1.json确实匹配到了PostsController#show动作。

额外排查点：有没有其他模板渲染逻辑？ #

检查你的PostsController有没有全局的before_action或者其他回调，可能无意中修改了渲染行为；另外，确认app/views/posts目录下有没有其他可能干扰的模板文件（比如show.json.erb这种同名不同后缀的文件）。

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