SwaggerHub の最新機能として、既存のツールセットとの連携により API ライフサイクルを推進する新しい方法である「インテグレーション」が追加されました。インテグレーションは、API 定義に追加できるソフトウェアの断片であり、ユーザーの制御下で SwaggerHub の機能を拡張します。以下の画像に示すように、API 仕様の右側に表示されます。
SwaggerHub は、当初、GitHub Sync と Webhooks の2つのユーザーインテグレーションを公開しています。
GitHub Sync
GitHub Sync を使用すると、生成されたコードを GitHub リポジトリと自動的に同期できます。これにより、ダウンロード、コードのマージ、複雑な設定、スクリプト作成が不要になります。生成するターゲット、GitHub リポジトリ情報、ファイル/フォルダー情報を指定するだけで、クライアントとサーバーは常に Swagger 定義と同期されます。クライアント、サーバーのいずれも、1つまたは複数のリポジトリにプッシュできます。Swagger は、Swagger コミュニティの専門家によって generously 提供された、28種類のクライアントと13種類のサーバーターゲットをサポートしています。これにより、多くのエンジニアが手作業で作成することなく、クライアント SDK を提供できます。また、同期プロセスを制御できるため、変更がジェネレーターによって上書きされる心配なく、SDK に追加のロジックを追加できます。
GitHub 同期がどのように機能するかを見るには、以下の短いスクリーンキャストをご覧ください。インテグレーションの詳細については、いつでも機能ドキュメントを読むことができます。
Webhook
Webhooks を使用すると、関心のあるライフサイクルイベント中に独自のサービスやインテグレーションをトリガーできます。トリガーされると、Swagger 定義は、多くのイベントに対して定義したサービスにプッシュされます。ビルドのトリガー、単体テスト、開発者へのメール送信など、SwaggerHub Webhooks を使用して自動化シナリオを考案できます。
上記の例の画像では、API のバージョンが保存されるたびに HTTP POST ペイロードが Jenkins に送信されます。ユーザーは複数のライフサイクルイベントを追加でき、HTTP POST フォームデータまたは JSON ボディのいずれかを介して JSON でペイロードが返されます。詳細については、機能ドキュメントをご覧ください。API 開発を迅速かつ効率的にするのに役立つ、今後の SwaggerHub インテグレーションにご注目ください！