SwaggerHub を使用してAPI 戦略を推進

~ API 設計とソフトウェア開発の間のギャップを埋める ~

SwaggerHub を使用してAPI 戦略を推進

API 定義は、最新のソフトウェアを構築するための最も重要なツールの 1 つになっています。 OpenAPI のような機械可読形式により、チームは、自動 API テスト、API モック、または API 標準化のいずれの場合でも、ソフトウェア開発プロセス全体を通じて信頼できる情報源として API 設計を使用できます。これらのチームは、製品のアイデアをより早く検証し、間違ったものを提供するリスクを減らし、世界中の他のチームと並行して作業することで、高品質のソフトウェアをより迅速に構築できます。これは、企業が競争上の優位性を育むのに役立つ慣行です。

たとえば、小売銀行のモバイルアプリケーションチームがアプリケーションに新しい機能を追加する必要があるとします。協力して必要な API の変更を定義すると、モックサーバーを生成し、API 開発者が API を構築するのを待たずにすぐに作業を開始できます。API が存在する前に、完全に機能するアプリケーションをユーザーに公開し、フィードバックを収集することもできます。このような短いフィードバックループを作成することは、分散したチーム全体で優れたアプリケーションを構築するための鍵となります。

しかし、この種のすべての作業をうまく行うには、企業は、最高の API 設計およびコラボレーションツールとサービスと組み合わせた強力な API 戦略を必要としています。 そして、これを大規模にうまく行うには、企業はこれらのツールとサービスを自動化に合わせて調整する必要があります。

大規模な優れた API 戦略の実装

組織全体で API を設計、構築、運用するには共同作業が必要です。 この取り組みには、チームが API を迅速、安全、一貫して、自信を持って構築するのに役立つ、明確に定義されたソフトウェア開発プロセスを備えた API 戦略が必要です。 適切な人材を集め、優れた戦略を定義し、選択したアプローチについて組織全体でコンセンサスを得て、製品チームと開発チームから賛同を得るためには、多くの作業が必要になります。

API 戦略を成功させるには、企業は API 戦略の採用を定義および推進できる経験豊富な API 実践者を必要としています。適切な API 戦略は、敏捷性を損なうことなくチームにガイダンスを提供し、速度を損なうことなく品質への道を提供します。最良の長期的な API 戦略は、顧客価値を推進するための企業の全体的なビジネス戦略と一致します。 API 戦略の実装は、1 回限りのプロジェクトではありません。むしろ、それは企業がソフトウェアを構築する方法の完全な変化です。

優れた API 戦略を大規模に実装するには、自動化が必要です。たとえば、企業は API 標準化を使用して、チームが一貫性のある高品質の API を構築できるように支援できます。しかし、企業の標準に対して API 定義を検証するプロセスを自動化する方法がなければ、標準に準拠するために無数の API を構築するグローバルに分散したチームを支援することはほぼ不可能です。自動化により、企業は、一元化された API チームが API 設計の細部をすべて確認する必要がなく、例外的に管理できます。ここで、SwaggerHub と新しい SwaggerHub CLI ツールが役立ちます。

SwaggerHub CLI を使用した API 戦略の自動化

SwaggerHub プラットフォームは、企業が強力な API 戦略を定義し、推進するために必要なツール、プロセス、およびベストプラクティスを提供します。 新しい SwaggerHub CLI を使用すると、チームは、ビルドパイプラインであろうと他の自動化サービスであろうと、自動化されたワークフローの中で SwaggerHub と対話できるようになりました。 これは、企業が大規模な API 戦略を実行する方法です。

SwaggerHub ツールのスイート全体を使用すると、チームは SwaggerHub のエディターを使用して API デザインで設計および共同作業し、SwaggerHub と一般的なソース管理サービスとの統合を通じてその API 定義を開発プロセスにプッシュし、API 定義を使用して、迅速なフィードバックを得るため、並行して作業を行うことができます。 SwaggerHub CLI を使用して、プロセス全体を通じて標準化とワークフローを自動化できるようになりました。

CLI が役立つ具体的なシナリオとは?

  • チームが新しい API プロジェクトをブートストラップしている場合、チームは CLI を使用して、必要な統合とともに SwaggerHub に新しい API を自動的に作成できます。これにより、新しい API プロジェクトを開始する際の摩擦を軽減し、チームが他のチームと同様のプロセスを使用できるようになります。
  • Code First チームが CI/CD パイプラインで OpenAPI ファイルを生成する場合、ビルドパイプラインで SwaggerHub CLI を使用して、SwaggerHub 内に新しいバージョンを作成できます。これにより、API とドキュメントを本番環境にデプロイされたものと同期させることができます。
  • 開発者がコードレビューで共同作業を行う場合、本番環境にデプロイする前に、最終的な標準化チェックを行うことができます。これにより、不正な設計や実装が本番環境に移行するのを防ぎます。
  • チームが新しいバージョンの API をデプロイする場合、チームは SwaggerHub CLI を使用して、デプロイされたバージョンを公開済みとしてマークできます。これにより、ドキュメントと API が連携し、開発者のエクスペリエンスが向上します。
  • 企業が開発者ポータルを持っている場合、チームは SwaggerHub CLI を使用して API 定義をプルダウンし、それを開発者ポータルにデプロイする自動化を構築できます。これにより、ポータルで最新バージョンを利用できるようになります。

SwaggerHub および OpenAPI のような API 定義形式は、API 設計とソフトウェア開発ライフサイクルの間のギャップを埋めるのに役立ちます。 チームは、API 定義を開発プロセスにプッシュし、ワークフローのさまざまなポイントで SwaggerHub と対話できます。 これにより、高品質の API を構築するための標準とプロセスを自動化できます。

自動化と SwaggerHub CLI の使用を開始する

新しい SwaggerHub CLI をダウンロードして、数分でワークフローの構築を開始できます。 SwaggerHub 開発チームは、新しい機能の追加に熱心に取り組んでおり、自動化プロセスを支援する機能を今後数か月以内に追加する予定です。 GitHub リポジトリをご覧になり、フィードバックを共有してください。

CLI に加えて、SwaggerHub は、API の設計と開発プロセスを橋渡しする GitHub、Bitbucket、GitLab、Azure DevOps などの多くの一般的な Git サービスへの統合を提供します。 SwaggerHub は、Apigee、AWS API Gateway、Azure API Management などの API ゲートウェイと統合して、継続的なデプロイを支援します。また、SwaggerHub は、オンデマンドで Git リポジトリにプッシュできるクライアント SDK とサーバー スタブを生成するための統合を提供し、開発プロセス全体をスピードアップします。 Git またはその他のソース管理ツールの SwaggerHub 統合について質問がある場合は、SwaggerHub 統合ページを確認してください。

SwaggerHub が API 戦略を大規模に推進するのにどのように役立つかに興味がある場合は、無料トライアルを利用してください。

SwaggerHub 製品の詳細はこちら。
OpenAPI 仕様に準拠した API 設計とドキュメント化のためのプラットフォーム

この資料は、SmartBear の Blog で公開されている「Using SwaggerHub to Drive Your API Strategy」の日本語参考訳です。

シェアする

  • このエントリーをはてなブックマークに追加

フォローする