APIファーストの実装

APIはソフトウェア・アプリケーションの中枢を形成する。 そのため、提供者は何を提供するかを明確にし、消費者は何を消費したいかを明確にすることが重要である。 APIをよりよく理解することで、優れたアウトプットが保証される。 APIファーストとは、プロバイダーと消費者の間に共通の合意を確立することである。 したがって、このデザインは両者が同じ見解を持つのに役立つ。

API Firstアプローチを採用すると、API開発者としてAPI契約からAPI開発を始めることができる。 実装の部分は後の段階で取り組めばいい。 実装よりもAPI設計を優先するこのアプローチは、プロバイダーと消費者の双方にとって有益である。

従来のシナリオでは、プロバイダーはAPIが実装された後に初めてコンシューマーにAPIを公開する。 消費者はAPIをテストし、APIに関するフィードバックをプロバイダーに提供する。 プロバイダーはその後、消費者から受け取ったフィードバックを取り入れるためにAPIを再検討しなければならない。 APIファーストの設計を採用することで、このプロセスを最適化することができる。

API Firstアプローチでは、コンシューマーはプロバイダーがAPIを実装するのを待つ必要はなく、公開されたAPIを使用してアプリケーション開発を進めることができる。 APIの実装状況は、モックされたAPIを通してリクエストに対する指定されたレスポンスを受け取るので、コンシューマーには影響しない。 そのため、API開発とアプリケーション開発を同時に行うことができる。

プロバイダがAPIを実装した後、エンドポイントはモックされたレスポンスではなく、実際の実装に呼び出しを振り向けるように更新される。 プロバイダーはモッキングを無効にすることができる。

以下の図は、API Firstの設計に沿ったAPI開発の流れを説明したものである。

API Firstの設計によれば、プロバイダーは開発が進行しているときに、そのAPIをコンシューマーに公開する。