このような分散型インフラストラクチャでは、さまざまなコンポーネントを統合する多くのAPIが存在します。Bonotelは、これらの異なるサービスを定義するためにSwagger（OpenAPI）仕様を使用しています。
Swaggerの導入当初、チームはRESTful APIの設計、構築、ドキュメント化にオープンソースのSwaggerツールを活用していました。しかし、社内外のチーム全体でAPI開発をスケールする必要が生じたとき、すぐに課題に直面しました。API開発が広範囲にわたるため、非常に多くのステークホルダーがAPIプログラムで作業しており、すべてのAPIアセットを一元的に管理することがますます困難になっていました。
ステークホルダーが適切なAPIに適切なタイミングで素早くアクセスし、新しいAPI定義について混乱なく共同作業を行う簡単な方法がなかったため、APIデリバリー全体の速度に影響が出ていました。ある時点では、Hastingsと彼のチームは、Bonotelの社内外のチームがAPI定義に一元的にアクセスできるように、バージョン管理システムに保存されているAPI定義を視覚化するカスタムコンポーネントを構築することさえ検討しました。
「プロジェクトを進めるにつれて、プロセスをスピードアップし、より効率的にする必要があることに気づきました」とHastingsは指摘します。「ユーザーインターフェースを自動生成し、社内外のチーム間のコラボレーションを手間やコミュニケーションの問題なしに促進したいと考えていました。」
Hastingsが改善を望んでいたもう1つの重要な機能は、異なるAPIバージョンを追跡する機能でした。チームが異なるバージョン間でAPIのすべての更新を追跡することはますます困難になっていました。
「すべてのAPIはプライベートであり、パートナーが閲覧できるようにするためにきめ細かなアクセス制御を使用してAPIを開放しています」とHastingsは説明します。「また、パートナーのユーザーアカウントを作成し、必要に応じて編集権限を付与できるようにしています。非常に多くの人々がAPIを扱っているため、異なるバージョンを綿密に追跡する必要があります。」
オープンソースのSwaggerツールからSwaggerHubへの切り替え
数か月間オープンソース版のSwaggerを使用した後、Hastingsはチームが必要とするより堅牢なソリューションを探し始めました。Swaggerテクノロジーに精通しているBonotelのパートナーの1人がSwaggerHubを推奨しました。SwaggerHubは、SmartBear Softwareが提供する統合されたAPI設計およびドキュメントプラットフォームであり、Swaggerを開発したチームによって構築されました。プラットフォームを評価した後、BonotelはSwaggerHubがAPI開発ワークフローにとって重要なツールであるとすぐに認識しました。
Bonotelにとって、SwaggerHubは、社内開発者と外部ステークホルダーの間でのAPI設計、ドキュメント、開発ニーズのための一元的なプラットフォームを提供しました。SwaggerHubがSwagger (OpenAPI) 仕様でのAPI開発のために特注されたものであるという事実により、Scottと彼のチームはAPI設計と開発をSwaggerHubに簡単に移行できました。
「以前はオープンソースのSwaggerツールチェーンを使用していましたが、SwaggerHubはコアのSwaggerテクノロジーを中心に構築されているため、私たちの側でのオーバーヘッドを最小限に抑えながらプラットフォームを簡単に導入できました」とHastingは指摘します。既存のAPIをシームレスに発見したり、新しいAPIに取り組んだりする機能により、Bonotelの開発チームはAPIワークフロー全体で一貫性と規律を推進できました。
「ツールを社内で検討し、SwaggerHubがすでに開発ライフサイクルに組み込まれている基本的なオープンソースのSwagger機能をどのように強化するかを見て、このソリューションが私たちのニーズを満たすとすぐに認識しました」とHastingsは言います。「SwaggerHubは非常にうまく機能し、他の選択肢は検討しませんでした。」
BonotelのSwaggerによるAPIデリバリーの変革
API作成のためのツールフレームワークとして、SwaggerHubはBonotelにAPIの設計とドキュメント化のための一元的なプラットフォームを提供します。きめ細かく安全なアクセス制御に支えられた一元的なAPI開発により、Bonotelは自信を持って外部パートナーにプラットフォームを開放し、戦略的目標を推進できます。Scottが気づいた顕著な変化の1つは、SwaggerHubを使用することでコラボレーションがどれほど合理化されたかでした。さまざまなチーム間のコミュニケーションも著しく改善されました。SwaggerHubコメントにより、Bonotelの社内外のチームは、重要なアイデアや提案についてリアルタイムでコミュニケーションできるだけでなく、API設計とドキュメントで対処する必要のある未解決の問題も追跡できました。
「SwaggerHubは、社内チームと外部パートナー間のAPI開発に関するコミュニケーションを劇的に改善します」とHastingsは強調します。「これは重要です。なぜなら、私たちは社内で多くのAPI開発を行っておらず、ほとんどの作業はパートナーを通じて行われ、パートナー同士も協力し合っているからです。SwaggerHubは、すべての可動部品間のコラボレーションのための集中ホストとして機能し、プロセスを非常に効率的で直感的、かつシームレスなものにします。」
API開発における混乱の削減
Bonotelの社内開発チームとQAチーム、および外部パートナーは、SwaggerHubを使用して効果的に連携し、一体となって作業しています。SwaggerHubソリューションは、API開発にかかる多くの時間を節約しただけでなく、コラボレーションにおける混乱と効率の低下を解消し、適切なアクセス制御でAPIドキュメントをホスティングすることに関連する可能性のあるインフラストラクチャ上の考慮事項を抽象化しました。SwaggerHubは、BonotelがAPIの新しい変更と更新を追跡することも可能にしました。ビジュアル比較とマージ機能に支えられたSwaggerHubのバージョン管理メカニズムにより、Scottと彼のチームは、どのAPIが更新され、更新されたAPIにどのような変更が追加されたかを正確に把握できました。
SwaggerHubが社内チームと外部開発者の間の主要なコラボレーションツールとして機能するようになったため、Hastingsと彼のチームはAPIファーストのアプローチで開発を進めることができるようになりました。
「これにより、物事がはるかに明確になります」とHastingsは付け加えます。「APIの設計とドキュメント作成を、一元化された安全なホスト環境でのコラボレーションと組み合わせることができます。」「RESTful APIをより迅速に設計および開発する機能を提供することで、新しいサービスやサービスアップデートをより早く市場に投入できます」とHastingsは言います。「これにより、SwaggerHubは当社のソフトウェア開発ライフサイクルにおける重要な要素となっています。」
優れたAPIを設計およびドキュメント化するために、チームの協力体制を変革する
Bonotelにとって、SwaggerHubへの切り替えのメリットは明らかでした。これらのメリットには以下が含まれます。
- 共同開発のためにRESTful APIの設計とドキュメントを統合する
- チームが混乱なくシームレスに協力できるようにする
- SwaggerHubコメントを使用して、さまざまなステークホルダー間の簡単なコミュニケーションを可能にする
- バージョン管理を促進し、既存のAPIに新しい更新を簡単に追加できるようにする
- 新しいAPIとサービスの市場投入速度を向上させる
チームがAPIを設計およびドキュメント化するために協力する方法を変革します。今すぐSwaggerHubを無料で試しましょう！