API分野でよく話題になることの一つは、企業がAPIのバージョンを非推奨にする、または人気のあるAPIのサポートを完全に終了するという決定です。 最近の例では、Googleが2017年1月にHangouts APIのサポートを終了すると静かに発表しました。これは、消費者向けビデオチャットアプリのDuoに注力するための動きであり、その結果、Hangoutsをエンタープライズ向けソリューションにするという決定につながったと推測されています。この決定は、Roll20やPingPongのようにこのAPIの上に構築されたアプリケーションに多くの不確実性をもたらしました。 公開APIは、サービスを提供する企業によって定義された、ある事業部門から別の事業部門への契約と考えるのが最適です。さまざまなサードパーティの開発者やパートナー部門は、そのようなAPIを使用して独自のサービスを構築できます。 この「オープンAPI」の概念は、アプリケーション開発者にとってイノベーションの原動力となってきましたが、同時に特定のリスクも伴います。公開APIを使用してアプリやサービスを構築する際のリスクの1つは、信頼性の低さというこの性質です。公開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開発者ポータルおよびそのドキュメントでも行うことができます。例えば、Swaggerフレームワークは、操作に対して非推奨タグをサポートしており、これによりインタラクティブなSwaggerドキュメントが更新され、ユーザーに非推奨の操作を通知します。 これについては仕様ドキュメントで詳しく学ぶことができます。 
十分なサンセット期間を提供する
これは、APIの非推奨化の最初の発表後、APIの消費者がアプリを再構成する時間を与える期間です。これは、APIの新しいバージョンをソフトウェアアーキテクチャに適合させるためのコードアップデートの形や、APIが無効になった場合に代替ソリューションに対応するプログラムの形で行われます。APIに依存する企業がビジネスおよび技術戦略の変更に取り組む時間を与えるため、適切なサンセット期間は重要です。非推奨化されるAPIの範囲、ユーザーベース、およびサービス提供に応じて、この期間は3〜8か月の間です。
効果的にバージョン管理する
APIの特定のバージョンを非推奨にすることは、効果的なバージョン管理によって容易になります。適切なバージョン管理を行うことで、APIの異なるバージョンが同時に存在することも可能です。APIを完全に非推奨にする前に、APIの次のバージョンを構築してリリースしてください。これはサンセット期間と関連しており、開発者やエンジニアに新しいAPIをサポートするために既存のアーキテクチャを再構築するのに十分な時間を提供します。 SwaggerHubには、APIバージョン管理システムがあり、複数のバージョンと反復のAPIを同時に存在させることができ、最新の安定したAPIをエンドユーザーに伝えるための分かりやすいメタ情報を提供します。これは、APIに存在するさまざまなバージョンと、消費に推奨されるバージョンについてエンドユーザーに情報を提供する最良の方法の1つです。
代替手段を提供する
APIがスムーズに機能するために依存する多くのアプリケーションや本格的なソフトウェアソリューションがあるかもしれません。APIの消費者がスムーズに移行できる、APIの最新バージョンへの移行計画、またはAPIが完全に削除された場合の他の代替案への移行計画は、最終消費者間の不満を軽減し、信頼を維持するのに役立ちます。APIが完全に非推奨になる前に、APIのサービスレベル契約でなされた約束とコミットメントを尊重することは常に良い考えです。その理由は、信頼を維持し、APIの消費者間の組織の評判を維持するためです。人々は話し、悪い口コミはブランドのアイデンティティに修復不可能な損害を与える可能性があります。Twitterは顕著な例です。過去に開発者との関係が悪かったことの矢面に立たされ、現在積極的にこれを再構築しようとしています。 要約すると、組織は、APIのバージョンであれ、サービス全体であれ、APIのサポートを無効にする理由、時期、方法について十分に検討する必要があります。組織は、適切な情報、適切なリソース、および適切な時間を提供することで、最終消費者が回復するのを助けるために時間と労力を費やす必要があります。そして最後に、組織は、APIの異なるバージョンを管理、バージョン管理し、最終的に廃止するために必要な適切なツールとインフラストラクチャに投資する必要があります。
APIエコノミーと組織のSwagger APIワークフローを最適化する方法
APIがビジネス目標の貴重な推進力として認識されるようになったのはごく最近のことであり、企業は現在、API戦略に多額の投資を開始しています。これには、SwaggerのようなAPI記述フォーマットの採用が爆発的に増え、開発を効率化し、組織のAPIの採用を促進するのに役立っています。今後のウェビナー、APIエコノミーと組織のSwagger APIワークフローを最適化する方法では、組織がAPI戦略をどのように考えるべきか、そしてSwaggerのようなAPI記述フォーマットがどのように役立つかを理解していきます。APIライフサイクルのワークフローを確立するためのベストプラクティスを提供し、チームがSwaggerHubを使用してAPIの設計、ドキュメント作成、開発で共同作業を行う方法を紹介します。取り上げるトピックの一部は次のとおりです。
- API戦略とは？
- APIが提示するビジネス機会とは？
- 成功するAPI戦略の要件とは？
- API開発への適切なアプローチを決定する
- SwaggerHubを使用してAPIワークフローを最適化する
ウェビナーは米国東部時間1月25日（水）午後1時に開催されます。今すぐ登録！