VMware Code Stream には、REST プラグインが提供されています。このプラグインを使用すると、REST API を使用する他のアプリケーションと VMware Code Stream を統合できます。これにより、情報をやり取りする必要があるソフトウェア アプリケーションを継続的に開発して配信できます。REST プラグインは、VMware Code Stream と別のアプリケーションとの間で情報を送受信する API を呼び出します。

REST プラグインでは、次のことが可能です。

  • 外部の REST API ベースのシステムと VMware Code Stream パイプラインを統合する。
  • VMware Code Stream パイプラインを外部システムのフローの一部として統合する。

REST プラグインは、どの REST API でも動作します。GET、POST、PUT、PATCH、DELETE の各メソッドをサポートしており、VMware Code Stream と他のアプリケーションとの間で情報を送受信できます。

表 1. REST API 経由で通信するためのパイプラインの準備
実行する操作 操作の結果
パイプラインへの REST タスクを追加する。

REST タスクは、アプリケーション間で情報を通信し、パイプライン ステージの連続するタスクに関するステータス情報を提供できます。

REST タスクで REST アクションを選択し、URL を含める。

パイプライン タスクは、パイプラインの実行時に URL を呼び出します。

POST、PUT、PATCH の各アクションには、ペイロードが含まれている必要があります。ペイロードでは、パイプラインの実行時にパイプラインとタスク プロパティをバインドできます。

使用例を検討する。

REST プラグインの使用例:

ビルドの Git コミット時にタグを作成する REST タスクを追加します。このタスクでは、リポジトリからチェックイン ID を取得する申請をポストします。タスクは、リポジトリにペイロードを送信し、ビルドのタグを作成できます。リポジトリは、そのタグを使用して応答を返すことができます。

REST プラグインを使用して API を呼び出す場合と同様に、パイプラインにポーリング タスクを含めて REST API を呼び出すことができます。API が完了し、パイプライン タスクが終了条件を満たすまで、API をポーリングできます。

また、REST API を使用してパイプラインをインポートおよびエクスポートし、サンプル スクリプトを使用してパイプラインを実行することもできます。

次の手順では、単純な URL を取得しています。

手順

  1. パイプラインを作成するには、[パイプライン] > [新しいパイプライン] > [空白のキャンバス] の順にクリックします。
  2. パイプライン ステージで、[+ シーケンシャル タスク] をクリックします。
  3. タスク ペインで、次の REST タスクを追加します。
    1. タスクの名前を入力します。
    2. [タイプ] ドロップダウン メニューで、[REST] を選択します。
    3. [REST リクエスト] 領域で、[GET] を選択します。
      REST タスクが別のアプリケーションにデータを申請するようにするには、GET メソッドを選択します。別のアプリケーションにデータを送信するには、POST メソッドを選択します。
    4. REST API エンドポイントを識別する URL を入力します。たとえば、https://www.google.com です。
      他のアプリケーションからデータをインポートする REST タスクには、ペイロード変数を含めることができます。たとえば、インポート アクションの場合、 ${Stage0.export.responseBody} と入力できます。応答データのサイズが 5 MB を超えると、REST タスクが失敗することがあります。

      機密性のある情報を非表示および暗号化するには、シークレット変数を使用します。非表示にして暗号化するだけでなく、実行時に使用を制限する文字列、パスワード、URL については、制限付き変数を使用します。たとえば、パスワードや URL にシークレット変数を使用します。シークレット変数も制限付き変数も、パイプライン内の任意のタイプのタスクで使用できます。

    5. タスクの認証を行うには、[ヘッダーの追加] をクリックし、ヘッダーのキーと値を入力します。
    パイプラインでの REST タスクの追加と設定。
  4. パイプラインを保存するには、[保存] をクリックします。
  5. [パイプライン] タブで、[パイプラインを有効にする] をクリックします。
    REST タスクを含むパイプラインの有効化。
  6. [保存] をクリックし、[閉じる] をクリックします。
  7. [実行] をクリックします。
  8. パイプラインの実行を監視するには、[実行] をクリックします。
    REST タスクを含むパイプラインの実行の監視。
  9. REST プラグインから想定どおりの情報が返されたことを確認するには、パイプライン実行とタスク結果を調べます。
    1. パイプラインの完了後、申請したデータが他のアプリケーションから返されたことを確認するには、パイプライン実行へのリンクをクリックします。
    2. パイプラインの REST タスクをクリックします。
    3. パイプライン実行で、タスクをクリックし、タスクの詳細を調べて、REST プラグインから想定どおりの結果が返されたことを確認します。
      タスクの詳細には、応答コード、本文、ヘッダー キー、および値が表示されます。
      REST タスクを含むパイプラインのタスク詳細。
  10. JSON 出力を表示するには、[JSON 出力の表示] をクリックします。
    パイプラインの REST タスクの JSON 出力の表示。

結果

完了です。REST API を呼び出し、REST プラグインを使用して VMware Code Stream と別のアプリケーション間で情報を送信する REST タスクを設定しました。

次のタスク

引き続きパイプラインで REST タスクを使用してコマンドを実行し、VMware Code Stream を他のアプリケーションと統合して、ソフトウェア アプリケーションを開発して配信できるようにします。ポーリング タスクを使用すると、API が完了し、パイプライン タスクが終了条件を満たすまで、API をポーリングできます。