API-first architecture
Concept
API ファースト アーキテクチャは、ユーザー インターフェイスより前に、ビジネス機能を安定した呼び出し可能な API として設計し、ユーザー インターフェイス、ワークフロー エンジン、AI エージェントが同じ操作を利用できるようにします。
あわせて取り上げられたテーマ
API-first architectureに関するエピソードでは、Computer-Using Agent (CUA)、Foundry Agent Service、Service account、Agent observability、Microsoft Agent 365、Software as a service (SaaS)も取り上げられています。
Description
API ファースト アーキテクチャは、ユーザー インターフェイスを構築する前に、ビジネス機能を安定した呼び出し可能な API として定義する設計手法です。その後、同じ操作がユーザー インターフェイス、ワークフロー エンジン、AI エージェントから利用されます。各クライアントが独自の経路でロジックにアクセスするのではありません。このモデルでは、外部の開発者、パートナー、AI エージェントが API を基盤として構築することが想定されるため、API はコードの副産物ではなく製品上の意思決定として扱われます。
API ファースト開発の中心的な要素は API コントラクトです。Microsoft の API ファースト開発に関する記事によると、コントラクトはエンドポイント、リクエストとレスポンスのデータ、想定されるエラーを記述し、実装やユーザー インターフェイスより前に作成されます。コントラクトは通常、機械可読な形式、最も一般的には OpenAPI で表現されます。コントラクトが承認されると、バックエンド チームはそれを実装し、フロントエンドとモバイルのチームはそこから生成されたモックに対して開発を進めます。ドキュメント、SDK、テストも同じソースから生成できるため、各成果物の整合性が保たれます。
このアプローチは、コード ファーストの開発と対比されることがよくあります。コード ファーストでは、API は既存のコードから生まれるため、内部の詳細が公開インターフェイスに漏れ出す可能性があります。API ファーストでは順序が逆になります。インターフェイスを意図的に設計し、それを満たすようにコードを書きます。Microsoft のページでは、トレードオフにも触れています。コントラクト ファーストの作業では事前のレビュー作業が増え、一方で利用者が少なく、インターフェイスが急速に変わることが想定される初期の社内ツールでは、コード ファーストも妥当な場合があるとしています。このページはベンダーの記事であり、Azure 固有の内容を含みます。
バージョン管理はこの手法の重要な部分です。利用者はコントラクトに依存するため、バージョン管理は利用者との合意として扱われます。バージョン内での追加的な変更は安全とみなされ、破壊的な変更には新しいバージョンが必要です。古いバージョンの廃止は Sunset ヘッダーで通知でき、利用者に突然の中断ではなく、移行のための明確な道筋を与えます。
さらに、1 つの API をゲートウェイの背後で、Web、モバイル、パートナー、エージェントの各クライアントに提供できる点も特徴です。これにより、認証とレート制限がすべての呼び出し元に一律に適用され、ビジネス ロジックが個別のチャネルで重複することもありません。この概念がエージェント主導のシステムに関連するのは、ソフトウェア エージェントが呼び出すための予測可能で文書化された操作を必要とするためです。
M365.FM のエピソード「Computer-Using Agents: How CUA Could Transform SaaS」は、API ファースト アーキテクチャをエージェント エコシステムに結び付けています。このエピソードでは、API ファースト アーキテクチャを採用すると、エージェント、システム、ワークフローを明確かつ予測可能な形で接続できるため、エージェント エコシステムが発展すると述べています。また、安定した API はインテリジェント システムの基幹であり、開発者は混乱を恐れずに技術革新を進めるためにそれに頼れると説明しています。さらに、拡張性も利点として挙げ、組織が変化する要件に適応する助けになると指摘しています。この文脈では、API ファースト設計は、エージェントが作成、自動化、拡張できるワークフローへの投資と並んで位置付けられます。
API ファースト アーキテクチャに関する典型的な判断には、どの機能を API として公開するか、どのコントラクト形式を使用するか、変更のバージョン管理と廃止をどう行うか、共有の認証とレート制限のためにゲートウェイをどこに置くかなどがあります。チームはまた、コントラクト レビューの事前コストと、フロントエンドとバックエンドの並行作業、生成されたドキュメントやテストの利点を比較検討します。
Overview compiled with AI from M365.FM episodes and the facts on this page. You can improve it with the edit button below.
| Type | Concept |
|---|---|
| Kind | Architecture |
Frequently asked questions
Questions marked with AI were written with AI from the facts on this page.
API ファースト アーキテクチャとはどういう意味ですか? (AI)
ユーザー インターフェイスより前に、ビジネス機能を安定した呼び出し可能な API として設計し、ユーザー インターフェイス、ワークフロー エンジン、AI エージェントがすべて同じ操作を利用できるようにすることを意味します。API コントラクトが先に定義され、実装がその後に続きます。
API ファーストはコード ファーストとどう異なりますか? (AI)
コード ファーストの開発では、API は既存のコードの副産物であり、内部の詳細が漏れ出す可能性があります。API ファースト開発では、通常 OpenAPI で記述されるコントラクトが、実装やユーザー インターフェイスの構築より前に設計・承認されます。
API ファーストが AI エージェントに関係するのはなぜですか? (AI)
エピソード「Computer-Using Agents: How CUA Could Transform SaaS」では、安定した API がインテリジェント システムの基幹であり、エージェント、システム、ワークフローを明確かつ予測可能な形で接続できると述べています。ゲートウェイの背後にある 1 つの API は、Web やモバイルのクライアントと並んで、エージェント クライアントにも提供できます。
Community wiki
Short info above, community knowledge below: add practical tips, examples or corrections. New contributions are reviewed first; trusted members publish directly.
Experts and companies for this topic
Nobody has listed this topic yet. Add it to your profile.
Maintained by Mirko Peters (Microsoft MVP) · Last updated: