Rails 5でJSONとしてVIEWを出力する

Rails 5 でJSONとしてVIEW・ビューをを出力する方法についてメモです。 respond_toとformat.jsonを使用します。

通常、RailsならVIEW.erbに書いたテキストに、テンプレートのHTMLが付加される感じになりますが、 これをJSONやXMLなどフォーマットを指定して、REST APIなどとして利用できるようにすることができます。

こんな感じで。

respond_to do |format|
            format.html

                @json=%({"origin":#{@origin_addresses.to_json},"dest":#{@destination_addresses.to_json},"km":#{@km.to_json}})

            format.json {render :json => @json}
end

respond_toはやってもやらなくてもいいのですが… 説明しておくと

respond_toを使うと、通常の ./page にアクセスされた場合には show.html.erb (このアクションメソッドが”show”だとして) が参照され、 ./page.json と、明示的に拡張子でjsonを要求された場合に、format.jsonで指定した、@json 変数の中身をjsonとして参照し、そのまま出力する、というようなことができます。

なので…API専用として使うだけっていうなら、わざわざrespond_toをする必要はないのですが。一応。

to_jsonは、変数をJSONとしてエスケープしてくれます。似たようなのでescape_Javascript(?)がありますが、こっち使ったほうがいいみたいです。