SmartBear Connect 2020 – SwaggerHub の新機能

(このブログは、SmartBear 社の Calvin Fudge 氏が 2020年 5月 14日に投稿したブログの参考訳です。)

私だけかもしれませんが、在宅勤務が増えたことで、つながりたいという気持ちが強まりました。先日、当社のバーチャル ユーザー会議「SmartBear Connect 2020」を開催しました。  出席者数や好意的な意見を参考にすれば、たとえ今はバーチャルなことしかできなくても、多くの人々がつながりを持ちたいと考えているようです。 

私は SmartBear API 製品のプロダクト マーケティング担当として、API 開発をサポートするセッション開発に携わっていました。いくつかのセッションに参加しましたが、その中でも API 設計に興味のある方にお勧めできるのが、プロダクト マネジメント ディレクターの Tim Maguire 氏による SwaggerHub のセッションです。このセッションのタイトルは「What’s New In SwaggerHub (SwaggerHub の新機能)」で、その概要を簡単にご紹介したいと思います。簡潔なスライドと補強のためのデモの組み合わせがとても良かったです。デモをご覧になりたい方のために、このブログ中にカウンター タイムを追加しました。 

プレゼンテーションではまず、最近の SwaggerHub 開発の指針となっており、2020 年に向けても継続している重点分野について説明します。これらの開発分野は次のとおりです。

  • 開発者の経験
  • 統合と自動化
  • ガバナンスと基準

最初のエリアである開発者の経験では、SwaggerHub に追加された新しい機能強化について紹介しています。その一つが、OAS3.0 for Domains のサポートです。SwaggerHub を初めてご利用になる方のために説明しますと、ドメインとは、製品内の共通コンポーネント (パラメーター、レスポンス、データ モデル) のライブラリで、複数の API 定義で再利用することができます。その正味の効果は、開発を加速し、生産性を高めることです。 

次に開発者の経験では、SwaggerHub のドキュメントを強化し、複数の例をサポートしています。何らかの形で API を処理するツールやライブラリに対して OpenAPI 仕様を明確にするために、オブジェクト、個々のプロパティ、および操作パラメーターの例を指定することができます。   

開発者の経験で取り上げた最後の項目は、SwaggerHub Visual Editor に関するものです。テクニカル ライターやビジネス アナリストが API をより簡単に操作できるように、新たな機能強化を行いました。

その後、セッションはデモ モードに移行し (先に進みたい場合は @4:17)、特にビジュアル エディターのセクションでは、開発者の経験の新しい変更点がよくわかります。ビジュアル エディターで説明を追加する方法は非常にシンプルで、Tim がビジュアル エディターとコード エディターの間の連続性を示しているのが印象的でした。

プレゼンテーションの次のセクションでは、統合と自動化のための SwaggerHub の機能に焦点を当てています。SwaggerHub では、レジストリ API の更新、Git 統合、自動インポート、Git 統合のバージョン管理という 4 つの機能強化が行われています。

SwaggerHub を初めてご利用になる場合、レジストリ API は、SwaggerHub が提供する API で、SwaggerHub レジストリ内の OpenAPI 定義の検索、取得、作成、更新を行うことができます。レジストリ API の新たな機能強化により、API の公開と非公開、API のデフォルト バージョンの設定が可能になり、CI/CD パイプラインとの統合を行う際に非常に便利です。 

セッションでは、Git ベースのリポジトリやその他のソース コントロール管理ツールとの統合に関する SwaggerHub のサポートについて、いくつかの強化点が紹介されました。例えば、Git の API 定義を SwaggerHub に自動インポートする機能があります。最後に、Git を使用した API バージョン管理を新たにサポートしました。SwaggerHub で API の新しいバージョンを作成すると、GitHub にも自動的に新しいバージョンが作成されます。統合とバージョン管理に関する SwaggerHub の新しい機能を説明するために、Tim がデモを行います。(@14:16)

このプレゼンテーションで取り上げられている SwaggerHub の次の強化分野は、ガバナンスと標準です。この分野の新機能には、シングルサイン オン (SSO) のサポート、Custom Docs のブランディング、API プロジェクトの強化、および API の標準化などがあります。

API のセキュリティを確保することは、組織内でますます大きな課題となっています。このようなニーズに対応するため、当社の SwargHub SaaS 製品に SSO サポートを追加しました。この新しい機能は SAML に基づいており、Active Directory、AuthO、Okta、OneLogin、Ping などの主要な SAML SSO プロバイダーをサポートしています。 

この分野のもう 1 つの強化点は、ドキュメントをカスタマイズする機能です。これはあまり重要ではないかもしれませんが、多くのお客様から、特定の色やロゴを使用して API ドキュメントをブランドに適合させる機能を求められています。 

SwaggerHub の API プロジェクトは、組織のオーナーが API やドメインを論理的に配置し、開発チームの他のメンバーに対する可視性を管理するのに役立ちます。SwaggerHub では、プロジェクトのワークフローに新たな機能を導入し、プロジェクトへの API の追加やプロジェクト間での API の移動が容易になりました。 

API の標準化は、設計プロセスにおいてガバナンスを強化する上で重要な役割を果たします。品質を維持しながら開発をスピード アップするために、多くの組織が API スタイル ガイドを使用しています。SwaggerHub には、操作やパラメータなどをチェックするルールがすでに組み込まれていますが、今回新たに追加されたカスタム ルールでは、業界固有のスタイル ガイドを用いた API 標準化のための独自のカスタム ルールを作成することができます。

ガバナンスと標準の分野で強化された新機能を実感していただくために、Tim は主要な機能のデモを行います。(@22:50) 実際にツールを使ってみることは何よりも大切です。このデモをじっくりとご覧ください。

一度、API 設計に興味を持つと、なかなかやめられません。SwaggerHub の無料トライアルはこちらからどうぞ。 

2 階のベッドルームやキッチン、または公式なホーム オフィスで匿名で仕事をしていても、あなたは 1 人ではなく、SmartBear があなたとつながっていることを知ってください。SmartBear は、Swagger、SOAPUI、Cucumber といった複数のオープン ソース コミュニティをサポートしています。たくさんのビデオやトレーニング教材を提供していますが、そのほとんどが無料です。また、SmartBear Connect 2020 についてはほとんど触れていないので、もっと専門家やお客様のセッションに興味がある方は、オンデマンドのリンクをチェックしてみてください。

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

この資料は、SmartBear の Blog で公開されている「SmartBear Connect 2020 – What’s New in SwaggerHub」の日本語参考訳です。

シェアする

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

フォローする