Code Stream 提供一個 REST 外掛程式,透過該外掛程式可以將 Code Stream 與使用 REST API 的其他應用程式整合,以便持續開發並傳遞必須彼此互動的軟體應用程式。此 REST 外掛程式會叫用 API,該 API 會在 Code Stream 與其他應用程式之間傳送和接收資訊。

透過此 REST 外掛程式,您可以:

  • 將以外部 REST API 為基礎的系統整合到 Code Stream 管線中。
  • Code Stream 管線整合為外部系統流程的一部分。

此 REST 外掛程式可與任何 REST API 搭配運作,且支援使用 GET、POST、PUT、PATCH 和 DELETE 方法在 Code Stream 與其他應用程式之間傳送或接收資訊。

表 1. 準備管線以透過 REST API 進行通訊
您執行的操作 產生的結果
將 REST 工作新增到管線。

此 REST 工作在應用程式之間傳遞資訊,並且可提供管線階段中連續工作的狀態資訊。

在 REST 工作中,選取 REST 動作並包含 URL。

當管線執行時,管線工作會呼叫該 URL。

對於 POST、PUT 和 PATCH 動作,必須包含裝載。在裝載中,您可以在管線執行時將管線與工作內容繫結。

以此範例為例。

REST 外掛程式的使用範例:

您可以新增 REST 工作以在建置的 Git 認可上建立標籤,並讓該工作發佈請求以從存放庫取得簽入識別碼。此工作可傳送裝載至存放庫,並為建置建立標籤,而存放庫可以透過該標籤傳回回應。

與使用 REST 外掛程式叫用 API 類似,您可以在管線中包含 Poll 工作以叫用 REST 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 工作並設定 REST 請求時,您可以選取動作,輸入 URL,並為授權新增任何標頭。
  4. 若要儲存管線,請按一下儲存
  5. 在 [管線] 索引標籤中,按一下啟用管線
    必須先啟用管線,然後才能執行。
  6. 按一下儲存,然後按一下關閉
  7. 按一下執行
  8. 若要監視管線的執行狀況,請按一下執行
    管線開始執行後,您可以在管線執行時觀察管線狀態。
  9. 若要確認 REST 工作是否傳回預期的資訊,請檢查管線執行和工作結果。
    1. 管線完成後,若要確認其他應用程式是否傳回了所要求的資料,請按一下管線執行的連結。
    2. 按一下管線中的 REST 工作。
    3. 在管線執行中,按一下相關工作,觀察工作詳細資料,並確認 REST 工作是否傳回了預期結果。
      工作詳細資料顯示回應代碼、本文、標頭索引鍵和值。
      REST 工作的詳細資料會顯示狀態 [COMPLETED]、回應代碼、回應本文,以及標頭索引鍵和值。
  10. 若要查看 JSON 輸出,請按一下檢視輸出 JSON
    REST 工作的 JSON 輸出會顯示回應標頭和回應本文,並包括用於搜尋內容的路徑尋找程式。

結果

恭喜您!您已設定了一個 REST 工作,該工作叫用 REST API,並使用 REST 外掛程式在 Code Stream 與其他應用程式之間傳送資訊。

下一步

繼續在管線中使用 REST 工作執行命令,並將 Code Stream 與其他應用程式整合,以便開發並傳遞軟體應用程式。考慮使用輪詢工作對 API 進行輪詢,直到完成且管線工作滿足結束條件為止。