railsでAPI作成する際のパスについて

Question

Ruby on Railsのルーティングについて質問です。

以下は、POSTされたJSONをDBに保存するというシンプルなAPIのルーティングです。

namespace :api, format: 'json' do
    namespace :v1 do
      resources :receive, only: [:create] do
    end
end

追加要件で、reveve APIを利用するお客様が増え、利用する会社ごとに
APIのエンドポイントを分けたいと考えております。

実現したいこと

A社
<doain>/api/v1/receive/a

B差
<doain>/api/v1/receive/b

このような実装を行う際のルーティングの設定、コントローラーディレクトリ構成はどのようにするのがベストでしょうか？

もう一階層増やして、 a_controller、b_controller...といったようにコントローラーを作成する事も考えたのですが、社名_controller.rbとなる部分に違和感がありました。

よろしくお願いいたします。

Comments

[maisumakun]

「利用する会社」が増えるという想定ですが、「各社ごとにコードを書く」ような感じで増えていくのか、それとも「設定で簡単に増やせる」ような感じのほうがいいのか、どちらで考えていますでしょうか。

[退会済みユーザー]

DB保存時に、各社ごとのデータ変換を行うフローがありますので、「各社ごとにコードを書く」ような感じで増えていくで考えております

[maisumakun]

社名部分は末尾でなければならないのでしょうか。「/api/v1/社名/receive」のようにしたほうが、自然に設計できるような気もします。

[退会済みユーザー]

いえ、そちらでも問題ないです。

Answer 1

追記欄を踏まえて、/api/v1/社名/receiveとした場合は、このようになります。

# 共通化して使い回す分
concern :one_company do
  resources :receive, only: [:create]
end

namespace :api, format: 'json' do
  namespace :v1 do
    namespace :teratail do
      concerns :one_company
    end

    namespace :other_company do
      concerns :one_company
    end
  end
end

このようにすると、Api::V1::Teratail::ReceiveControllerとApi::V1::OtherCompany::ReceiveControllerに割り振ることができます。

Comments

[退会済みユーザー]

ご丁寧な回答、感謝です。
無事実装できましした。