APIカタログ

APIカタログとは？

APIカタログは、検索可能で高度に整理されたAPIライブラリです。利用者が関心のあるAPIを見つけて活用しやすくなります。プライベートAPIカタログには、組織内のすべての内部APIが含まれており、チームが冗長なコードを特定し、組織全体の標準に従うことで、API管理プロセスを効率化します。一方で、パブリックAPIカタログは、APIの提供者とサードパーティの利用者を結びつけ、開発者コミュニティの育成、フィードバックループの短縮、収益の創出を促進します。プライベートおよびパブリックAPIカタログに掲載されるAPIには、ドキュメント、リクエスト例、テストなどの関連成果物が含まれることもあり、利用者の「初回呼び出し（time to first call）」までの時間短縮に貢献します。

ここでは、プライベートおよびパブリックAPIカタログが解決する様々な課題と、Postman APIプラットフォームがどのように役立つかについて説明します。しかしまず、APIファーストの世界でAPIカタログが果たす役割について探ります。

APIファーストの世界でAPIカタログが重要な理由は？

APIファーストとは、内部または外部のサービスをAPIとして提供し、それらを組み合わせてアプリケーションを構想・構築する開発モデルです。このアプローチは近年急速に広まり、さまざまなAPIユースケースをサポートしています。たとえば、マイクロサービスベースのアーキテクチャにおいては、アプリケーションが相互に通信するサービス群として構築されるため、この開発手法が欠かせません。さらに、API品質を重視する点も特徴であり、APIを課金対象の製品としてサードパーティの利用者に提供するチームにとって、堅実なフレームワークとなります。

プライベートAPIとパブリックAPIは、組織全体のビジネス戦略において異なる役割を担いますが、それらを管理するチームにとって、APIカタログがもたらす発見性、コラボレーション、ガバナンスの改善効果は等しく有益です。

プライベートAPIカタログとパブリックAPIカタログの違いは？

プライベートAPIカタログとパブリックAPIカタログはいずれも、API利用者がニーズに合ったAPIを見つけやすくしますが、それぞれに固有のメリットがあります。

プライベートAPIカタログのメリット

プライベートAPIカタログは、組織内のすべての内部APIを集約する統一ハブです。これにより、組織全体のAPIランドスケープ（APIの状況）を可視化できるため、開発者にもビジネスリーダーにも利点があります。たとえば、プライベートAPIカタログを活用すれば、ユーザー認証などの一般的なワークフローのために冗長なコードを書く必要がなくなります。代わりに、他チームが同じ目的で開発したAPIを検索・発見・利用できます。さらに、社内APIの利用傾向をリアルタイムで把握できるため、帯域幅配分に関する重要な意思決定を行う際にも役立ちます。加えて、APIカタログの中央集約的な特性により、組織全体のチームに対して一貫したAPIガバナンス戦略を実行しやすくなります。

パブリックAPIカタログのメリット

パブリックAPIカタログは、APIをサードパーティの利用者に対してより発見しやすくします。APIを課金可能な製品として提供している企業にとって、APIの可視性が高まることで、トラフィックおよびひいては収益の増加につながります。また、パブリックAPIカタログは、利用者と提供者の間に存在するサイロを取り払い、フィードバックループを短縮し、提供者が適切なサポートを提供する助けにもなります。

APIスプロールとは？プライベートAPIカタログはどのように役立つか

上記で説明したように、多くのチームが単一の（モノリシックな）アプリケーションをマイクロサービスに分割し、テクノロジースタックの近代化を図っています。マイクロサービスはAPIを介して相互に接続されており、個別にデプロイ、プロビジョニング、スケーリングが可能なため、コスト管理の柔軟性や迅速な反復、トラフィック増への対応が容易になります。

しかし、マイクロサービスの導入には課題もあります。たとえば、ソフトウェアアーキテクトにとっては、従来の一体型アプリケーションの処理（レガシーモノリスのロジック）をどのように分離するかの判断が難しいことがあります。その結果、再利用不可能なマイクロサービスが乱立したり、ビジネスニーズの変化によりAPIが放置・放棄されることもあります。これにより、APIの全体像が不透明になり、管理が困難となり、セキュリティ上のリスクも高まります。実際、Postmanの「Postman's 2022 State of the API report」レポートでは、マイクロサービスの過剰増殖が、API提供者にとって最大の課題の一つであると指摘されています。

プライベートAPIカタログは、「APIスプロール」と呼ばれるこの現象への対抗策となります。組織のコードベース内にあるすべてのAPIを把握することで、冗長・陳腐化・非準拠なAPIを特定し、必要に応じて廃止・修正できます。APIカタログが整備されることで、チームはより戦略的にAPI開発に取り組めるようになり、必要かつ安全で高品質なAPIのみが組織内で運用されるようになります。

PostmanはAPIカタログをどのようにサポートしますか？

G2によって最高のAPI管理ツールと評価されたPostman APIプラットフォームは、開発者がAPIカタログの利点を活用するための2つの手段を提供しています。まず、組織はAPIをパブリックAPIネットワークに登録できます。これは、世界最大のパブリックAPI成果物のハブであり、Postmanコミュニティのメンバーは以下のような利点を得られます。

• 開発者エコシステムを成長させる：パブリックAPIネットワークにAPIを公開することで、世界中の3,000万人以上の開発者とつながることができます。
• 利用者に直接サポートを提供する：チームはパブリックAPIネットワークを使用して、リクエスト例、デフォルト設定、ドキュメントを公開することで、APIの導入を促進し、サポートチケット数を削減できます。
• 探索してインスピレーションを得る：開発者は、Public API Network内のアセットをカテゴリやチームごとに閲覧できるほか、Postmanのチームが厳選した注目のコレクションやワークスペースも確認できます。

さらに、チームはプライベートAPIネットワークを利用して、社内向けAPI成果物のカタログを構築できます。これにより以下が可能になります。

• 内部API、ワークスペース、コレクションを発見する：プライベートAPIネットワークは、組織内のすべてのAPI、ワークスペース、コレクションへの可視性が確保され、チームが協力し互いから学ぶのに役立ちます。
• 内部API状況を管理する：リーダーはプライベートAPIネットワーク内のAPI活動に関するより深い洞察を得るためにレポートにアクセスできます。たとえば、レポート機能を用いて、プライベートAPIのリクエスト数、パフォーマンス、テストの失敗、SLA遵守を追跡し、内部APIの状況を把握できます。
• ネットワーク管理者は、オプションの承認ワークフローを活用することで、品質管理を行うことができます。これにより、レビューおよび承認済みの成果物のみがプライベートネットワークに公開されるようになります。