質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.50%
SPA(Single-page Application)

SPA(Single-page Application)は、単一のWebページのみでコンテンツの切り替えができるWebアプリケーションもしくはWebサイトです。ブラウザでのページ遷移がないため、デスクトップアプリケーションのようなUXを提供します。

REST

REST(Representational State Transfer)はwebアプリケーションの構築スタイルの一種です。HTTP GET/POSTによってリクエストを送信し、レスポンスはXMLで返されます。SOAPのようなRPCの構築と比べるとサーバからクライアントを分離することが出来る為、人気です。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

Q&A

0回答

3329閲覧

SPAにおけるAPIの設計はフロントの画面に寄り添うべきか?

Sa2Knight

総合スコア11

SPA(Single-page Application)

SPA(Single-page Application)は、単一のWebページのみでコンテンツの切り替えができるWebアプリケーションもしくはWebサイトです。ブラウザでのページ遷移がないため、デスクトップアプリケーションのようなUXを提供します。

REST

REST(Representational State Transfer)はwebアプリケーションの構築スタイルの一種です。HTTP GET/POSTによってリクエストを送信し、レスポンスはXMLで返されます。SOAPのようなRPCの構築と比べるとサーバからクライアントを分離することが出来る為、人気です。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

0グッド

5クリップ

投稿2018/09/13 14:10

前提

こんにちは。私は業務にて、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の設計はこうであるべきなどありましたら、是非ともご意見をお聞かせください。

よろしくおねがいします。

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだ回答がついていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問