【要約】APIとは何か調べてみた｜REST・SOAP・JSON・XML・CRUD…用語を業務の言葉に置き換える [Qiita_Trend] | Summary by TechDistill
> Source: Qiita_Trend
Execute Primary Source
// Problem
システム連携の要件定義において、担当者はAPIの膨大な用語に直面し、どれが業務判断に直結するかを判別できない問題がある。技術的な詳細に惑わされ、実務上の制約を見落とすリスクが存在する。
- ・用語の氾濫による、技術的な詳細と業務的な要件の混同。
- ・「APIの有無」のみを確認し、データの更新可否（CRUD）を見落とすリスク。
- ・リアルタイム性の実現手段（Webhook）の確認不足による、設計ミスやコスト増。
// Approach
筆者は、APIの仕様を「どこに・何を・どんな形で・いつ」という4つの業務的な問いに集約し、技術用語を整理した。
- ・4つの質問への集約: エンドポイント、CRUD、JSON/XML、Webhookとして定義。
- ・実態調査の実施: 日本の業務システム56件を対象に、通信形式や仕様の公開状況を定量的に分析。
- ・実務的な確認手順の提示: 仕様書のどの項目を見れば、4つの問いに答えられるかを具体化。
// Result
本アプローチにより、ベンダーとの交渉やシステム選定において、具体的かつ技術的な根拠に基づいた質問が可能になる。
- ・REST/JSONが日本の業務システムにおける事実上の標準であることを特定。
- ・「読み取り専用API」や「CSV連携」といった、API以外の実態を把握。
- ・APIのバージョン管理が、将来的な保守コストに直結することを認識。
Senior Engineer Insight
> 本記事は、技術の深掘りではなく「技術の境界線」を定義している点が実用的だ。特に、APIの有無だけでなく「CRUDの範囲」と「Webhookの有無」をセットで確認せよという指摘は、設計段階での手戻りを防ぐ上で極めて重要である。大規模システムにおいて、ポーリングによる過剰なリクエストはレイテンシとコストを悪化させる。Webhookの有無を初期要件に組み込むべきだ。