前提
こんにちは。私は業務にて、RailsとVueを用いたSPAの開発に従事しており、主にAPIの設計、実装を担当しております。RailsによるAPIの概要は以下の通りです。
- フロントエンド及びネイティブアプリから呼び出され、リクエスト、レスポンスともにJSONを用いる
- APIの一般公開や外部への提供は一切なく、内部での利用に限定している
- RESTベースで設計、実装しているが、後述の理由から、RESTfulとはとても言えない
困りごと
前述の通り、APIはRESTベースになっており、初めの頃はなるべくシンプルなCRUDを提供しようと、キレイなRESTFulを目指していました。
しかし、開発が進むにつれ、フロントエンド側のエンジニアから、「この画面ではこういうUIがある都合、APIではこのデータもまとめて返却してほしい」「この一連の操作で一貫性を保たないといけないから、API呼び出し1回で済むようにしてほしい」などのように、APIを呼び出す画面ごとの機能に特化した仕組みをAPIが単一エンドポイントで提供することを希望することが多くなりました。
確かにフロント側にとってみれば、その画面にとって必要な機能を、1回のAPI呼び出しで全て解決できれば実装も楽になりますし、リクエスト回数による通信不可も削減できると思います。
しかし、あまりにAPIがフロント側に寄り添いすぎると、各エンドポイントの責務が曖昧になったり、どのモデルにも属さない、汎用的な機能が出来上がったり、本来単純な機能提供をしていたAPIを複数箇所で再利用することができなくなったりと、保守の観点からあまり望ましくないのではとも考えています。
こういった問題に絶対の正解はないと思いますし、それこそプロダクトの特性や、チームの状態などによって良し悪しが変わることも承知の上です。なので参考までにはなりますが、皆様はそういった経験がある場合、どのように折り合いをつけたのでしょうか。経験はなくとも、APIの設計はこうであるべきなどありましたら、是非ともご意見をお聞かせください。
よろしくおねがいします。
あなたの回答
tips
プレビュー