~/blog/output-view-as-json-rails-5
Published on

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

762文字2分で読めます–––
閲覧数
Authors
  • avatar
    Name
    Shou Arisaka nyapp.buzz/shou
    short bio
    Z世代の情報技術者。Next.jsで自作SNSを個人開発中。

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(?)がありますが、こっち使ったほうがいいみたいです。

avatar

Shou Arisaka

情報技術者 / Z世代プログラマー / SaaSアプリやSNSを開発
今すぐ話そう!

15歳でWordPressサイトを立ち上げ、ウェブ領域に足を踏み入れる。翌年にはRuby on Railsを用いたマイクロサービス開発に着手し、現在はデジタル庁を支えたNext.jsによるHP作成やSaaS開発のプロジェクトに携わりながら、React.js・Node.js・TypeScriptによるモダンなウェブアプリの個人開発を趣味でも行う。
フロントエンドからバックエンドまで一貫したアジャイルなフルスタック開発を得意とし、ウェブマーケティングや広告デザインも必要に応じて担当、広告運用・SEO対策・データ分析まで行う低コストかつ高品質な顧客体験の提供が好評。
国内外から200万人を超える人々に支えられ、9周年を迎えるITブログ「yuipro」の開発者、デザイナーでありライター。現在ベータ段階の自作SNS「nyapp.buzz」を日本一の国産SNSとするべく奮闘中。

Created with Fabric.js 5.2.4 何かご質問がありますか?