[備忘録]RailsでWebAPIをつくるときに抑えておくとよさそうなこと

転職をして、Railsを触り始めました。

慣れるまでに時間はかかりそうですが、慣れるとスピーディに機能追加できそうでいいなと思いました。

業務では今WebAPIを触ることがメインで、それに関することをざっくりとまとめました。

どの処理のときに何を使えばいいかをまとめています。

• リクエストを受け取れるようにする→ルーティング
  • https://railsguides.jp/routing.html
• リクエストを受け付けるとき
  • リクエストを受け付けたときの全体の処理の流れを定義する→Controller
    • https://railsguides.jp/action_controller_overview.html
  • リクエストパラメータで許可したものだけ受け付けるようにする→Strong Parameters
    • https://railsguides.jp/action_controller_overview.html#strong-parameters
  • リクエストを一度格納する→Active Model(フォームオブジェクト
    • https://applis.io/posts/rails-design-pattern-form-objects#form%E3%82%AA%E3%83%96%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AE%E5%BF%85%E8%A6%81%E6%80%A7
      • もっと適切なものがあるかもしれない。
    • パラメータの妥当性をチェックする→ActiveModel::Validations
• メインの処理（ビジネスロジック）を行う→複雑さによる
  • データベースのテーブル（少なめ）とのやり取りを行い、ロジックはシンプル→Active Record
  • 複雑→さまざまな議論がされて、いろいろなやり方があるよう。
    • https://techracho.bpsinc.jp/hachi8833/2021_01_07/14738
    • https://techracho.bpsinc.jp/hachi8833/2022_03_17/46482
    • https://tech.giftee.co.jp/entry/2023/02/20/000000
• レスポンスを返すとき
  • JSONやXMLなどのフォーマットでレスポンスを作成する→シリアライザー
    • https://railsguides.jp/active_model_basics.html#serialization%E3%83%A2%E3%82%B8%E3%83%A5%E3%83%BC%E3%83%AB
  • HTMLでレスポンスを作成する→Action View
    • https://railsguides.jp/action_view_overview.html
  • 例外発生時に返すレスポンスを定義する→resuce_from
    • https://railsguides.jp/action_controller_overview.html#rescue-from

認証認可やビュー、ジョブとか、他にもいろいろあるし、WebAPI自体に使えるものももっとあるだろうけど、まずはこれだけ。