既存のRailsアプリにJSONを返すAPIを実装したい上でのベストプラクティス

Question

やりたい事
・既存のrails webアプリにAPIを実装する
・リクエストしてきたクライアントによってサーバーで返す値を変えたい
・現状はアクションの最後に@〇〇と書いてview(erb)に値を渡しているのみ

ネットで調べているとrailsをapiとして使いたい場合は
apiモードとしてプロジェクトを立ち上げクライアント側から呼び出しているサンプルが大半で、既存のアプリにどう組み込むかという記事が少ない気がしています。

今はこちらの記事を参考に、
https://qiita.com/kotaroooo0/items/1af71180c220e112dcd3

webからリクエストが来た場合と、iOSからリクエストが来た場合に返す値を切り分けたいと考えています。
そこで質問なのですが、
このように既存のwebアプリにAPIを組み込みたい場合、コントローラーごと通常用とAPI様で切り分けるべきなのでしょうか？

例えばbooks_controller.rbとbooks_api_controller.rbを作成し、ベットapiコントローラーのルーティングを作る。
apiコントローラーの値はjbuilderを使ってjsonを組み立てるべきか。

もしくはrespond_toメソッドとjbuilderを組み合わせて使って

respond_to do |format|
 if @book.save!
    format.html { redirect_to root_path }
    format.json {render :json => オブジェクト}
 end

の様に一つのコントローラーで完結すべきなのかという質問です。

ご回答よろしくお願いします。

Answer 1

一個人としての意見ですが、

例えばbooks_controller.rbとbooks_api_controller.rbを作成し、ベットapiコントローラーのルーティングを作る。

こちらを選択すべきだと思います。

APIに手を加えてバージョンアップし、返すパラメータの構造に変更があった場合、古いバージョンのAPIを利用しているものについて不具合が生じることのないように旧バージョンと新バージョン両方とも利用できるような形にする場合が多いです。

api/v1/books
api/v2/books

のようにバージョンごとにURLを用意し、

app
└ controllers
　 └ api
　 　 ├ v1
　 　 │ └ books_controller.rb
　 　 └ v2
　 　 　 └ books_controller.rb

バージョンアップするごとにディレクトリを掘っていくような形です。こういった運用を想定した場合、必然的に

例えばbooks_controller.rbとbooks_api_controller.rbを作成し、ベットapiコントローラーのルーティングを作る。

といった方法を取らざるをえなくなると思います。

ただしAPIを外部に公開することなく、返すパラメータに変更があった場合の考慮が不要な場合はその限りではないです。

Comments

[widget11]

なるほど！！！勉強になります！
よくあるAPIのrequest urlがこんな感じですよね！
ありがとうございます！

Answer 2

WebAPIというのは単にJSONを返すだけのものです。
また、HTMLを返す必要はないので、respond_to formatすら不要です。

class SampleController 
  
  def sample
    # クライアントへ返却する結果
    # HashまたはArray
    result = {
    }
    
    render json: result
  end

end

jsonを構築するところは、jbuilderを使っても良いですし、
普通にHashやArrayをコードでガリガリ書いて行ってもOKです。

APIと通常のウェブページでは、利用シーンや求められる機能が異なるのが一般的です。
従って、API専用コントローラを作るべきと考えます。