APIガバナンスのベストプラクティス

Janet Wagner 著

アプリケーションやシステムとAPIを統合する企業の数は日々増加しています。Cloud Elementsの2018年API統合状況レポートによると、調査対象となったAPI業界専門家の61%が、API統合はビジネス戦略にとって重要であると考えており、57%が自社をプラットフォームプロバイダーと考えていると回答しています。

API主導のビジネス戦略を積極的に展開している企業にとって、ガバナンスは不可欠です。

ガバナンスは、API設計プログラムやマイクロサービスアーキテクチャを持つ組織にとって特に有益です。この記事では、APIガバナンスが重要な理由と、いくつかのAPIガバナンスのベストプラクティスについて説明します。

APIガバナンスの主要な目標:一貫性

自社をプラットフォームプロバイダーと見なす企業の数が増加しており、APIとアプリケーションを構築する企業の数も増加しています。そして、組織が大きくなるほど、企業が構築および利用するAPIの数も多くなる可能性が高くなります。組織によって構築されたアプリケーションは、内部APIとサードパーティAPIの両方を使用することがよくあります。

製品構築におけるAPIファーストアプローチに関する記事で説明しているように、一貫性が鍵となります。ガバナンスプロセスは、組織全体でAPIが一貫していることを保証するのに役立ちます。ガバナンスは、重複コード、コンポーネント間の緊密な結合、信頼性の欠如、過剰なサービスなどの問題の発生を防ぐのにも役立ちます。

APIの所在は把握していますか?

APIエバンジェリストのKin Laneは、最近記事を発表し、APIガバナンスに関して、彼はしばしば「自社のAPIの所在を把握していない」企業に出会うと述べています。Laneは、APIガバナンスを実装および維持する前に、いくつかのことを行う必要があると推奨しています。それらの中には、APIの所在を把握し、既存のAPIのインベントリを作成し、組織図を作成することが含まれます。

APIに関してどこにいるかを把握する必要があります。そうすることで、APIでどこを目指していくかを計画できます。

APIガバナンスには何が含まれるべきですか?

APIのインベントリを作成したら、APIガバナンスには何が含まれるべきでしょうか?

1. 集中化

ポリシーが作成および施行される中心点。通常、組織全体でAPIガバナンスを処理するチームが作成されます。

2. APIコントラクト

一部の企業は、別のブログ記事で説明しているアプリケーション開発にAPIファーストアプローチを採用しています。コントラクトを確立することで、APIの一貫性と再利用性を確保できます。また、開発チームが並行して作業することも可能になります(チームはモックを作成し、テストし、APIを展開できます)。

3. スタイルガイドライン

API設計を標準化することで、組織によって構築されたすべてのAPIが一貫性を保つことができます。API設計を標準化する1つの方法は、すべてのAPIのスタイルガイドラインを確立して施行することです。SwaggerHubには組み込みのスタイル検証機能があるため、組織はすべてのAPIでスタイルの一貫性を維持できます。

4. 再利用性

API設計を標準化することで、組織全体のAPIの一貫性が確保されるだけでなく、再利用可能なコンポーネントも含まれるようになります。SwaggerHub Domainsは、設計リソースの再利用性を向上させるのに役立ちます。

5. 自動化

APIコントラクト、ドキュメント、追跡は自動化できるプロセスであり、全体的なAPIガバナンスの一部であるべきです。そして、今日では、API設計とガバナンスのプロセスを自動化する多くのツールがあります。たとえば、SwaggerHubは設計スタイルの標準化と共通モデルの管理のためのツールを提供しています。

6. バージョン管理

バージョン管理は、開発者がAPIのさまざまなバージョンを追跡および維持するのに役立ちます。新しいバージョンで古いバージョンのAPIが置き換えられた場合、バージョン管理を使用して古いバージョンを非推奨にすることができます。コンテンツネゴシエーションは、APIのさまざまなバージョンを追跡するもう1つの方法です。バージョン管理またはコンテンツネゴシエーションは、特定の状況に応じて機能する可能性があります。

7. 非推奨ポリシー

バージョン管理は、APIの非推奨化をはるかに容易にするのに効果的に役立ちます。効果的な非推奨ポリシーは、APIのコンシューマーに安定性を提供するため有益です。開発者はAPIが非推奨になった場合に何を期待するかを知ることができ、APIが最終的に廃止される時期と方法を制御できます。

8. トラッキング

APIの多くの側面を追跡することは、APIガバナンスの一部である必要があります。APIが展開されている場所、APIを使用しているユーザー、APIの使用方法、ルーティング情報、およびAPIライフサイクルのその他の要素を追跡します。

9. APIディスカバリー

APIとガバナンスツールの数が多くなるにつれて、展開されたAPIと現在使用されているツールを簡単に検索して検出する手段を提供することが必要になります。依存関係を示す方法も、APIを消費するアプリの将来への影響を分析するために必要になります。たとえば、Capital Oneはサービスディスカバリーポータルを実装し、そのポータルへの自動公開を有効にしています。

なぜAPIガバナンスを実装するのですか?

APIガバナンスは、API全体で一貫性を確保し、コンポーネントの再利用を可能にし、特定の目標を達成し、ビジネスに価値をもたらすためにAPIを積極的に構築することを可能にするため、時間とコストの節約に役立ちます。APIガバナンスは、企業がAPIプログラムに関する賢明な意思決定を行い、APIの構築、展開、消費のためのベストプラクティスを確立するのにも役立ちます。

組織の全員がAPIに関して同じ認識を持っている場合、APIプログラムはより効率的で、価値があり、成功します。

APIガバナンスポリシーの実装をご検討ですか?SwaggerHubがどのように役立つのかをご覧ください。

ご精読ありがとうございました!さらにAPIリソースをお探しですか?Swaggerニュースレターを購読してください。最高のAPI記事、トレーニング、チュートリアルなどを毎月メールでお届けします。 購読

 

目次