APIガバナンスにおけるベストプラクティス

執筆:ジャネット・ワグナー

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

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

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

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

自社をプラットフォームプロバイダーと見なす企業の数が増加しており、APIやアプリケーションを構築する企業の数も同様です。組織が大きくなるほど、企業が構築し消費するAPIの数は増加する傾向があります。組織が構築するアプリケーションは、内部APIとサードパーティAPIの両方を使用することがよくあります。

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

あなたのAPIはどこにありますか?

APIエバンジェリストのキン・レーンは最近、APIガバナンスに関する記事を公開しました。その中で彼は、「自社のAPIがすべてどこにあるのかすら知らない」企業にしばしば遭遇すると述べています。レーンは、APIガバナンスを実装し維持する前に、いくつかのことを行う必要があると推奨しています。その中には、APIの場所を把握し、既存のAPIのインベントリを作成し、組織図を作成することが含まれます。

APIでどこに行きたいかを計画する前に、まずAPIに関してどこに立っているかを知る必要があります。

APIガバナンスには何を含めるべきか?

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

1. 一元化

ポリシーが作成され、施行される中央のポイント。通常、組織全体でAPIガバナンスを扱うチームが設立されます。

2. API契約

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

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

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

4. 再利用性

APIデザインを標準化することは、APIが組織全体で一貫していることを保証するだけでなく、再利用可能なコンポーネントも含むことを保証します。また、SwaggerHub Domainsは、デザインリソースの再利用性を向上させるのに役立ちます。

5. 自動化

API契約、ドキュメント、トラッキングは、自動化できるプロセスであり、全体のAPIガバナンスの一部であるべきです。現在、APIデザインとガバナンスプロセスを自動化する多くのツールが利用可能です。例えば、SwaggerHubはデザインスタイルを標準化し、共通モデルを管理するツールを提供しています。

6. バージョニング

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

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記事、トレーニング、チュートリアルなどをお届けします。 購読する

 

目次
© . This site is unofficial and not affiliated with Swagger.