測試自訂 API

Oracle Mobile Hub 中,您可以使用模擬資料在部署自訂 API 之前進行測試。您也可以使用支援兩種模式的測試頁面來測試 REST 連線器:標準測試和進階測試。

測試 Oracle Mobile Hub 自訂 API

若要直接從 Oracle Mobile Hub 測試您的自訂 API,請執行下列動作:

  1. 登入 Oracle Mobile Hub
  2. 按一下功能表圖示,然後展開開發,然後按一下後端
  3. 選取您的行動後端,然後按一下開啟
  4. 按一下左側導覽列中的設定值
  5. 環境 URL 底下的 SSO 記號端點複製 URL。
  6. 將複製的 URL 貼到 Web 瀏覽器視窗中,但不要按 Enter 鍵。
  7. 複製位於 OAuth 用戶區段下的從屬端 ID。
  8. 將查詢字串參數新增至您在 Web 瀏覽器中以 ?clientID=[YourClientID] 格式貼入的 SSO 權杖端點 URL,然後按 Enter 鍵。URL 的範例如下:
    https://<YourSSOTokenEndpointURL>?clientID=<yourClientID>
    瀏覽器會顯示 Single Sign-On OAuth 記號。
  9. 在行動後端視窗中,按一下左側導覽中的 API 頁面。瀏覽器將從設定值頁面變更為 API 頁面。
  10. 按一下選取 API
  11. 按一下您想要測試的 API 名稱。此時會開啟一個新頁面,其中顯示左側導覽中的 API 端點以及要求回應頁籤。
  12. 按一下要測試的端點。
  13. 認證段落下,從認證方法中選取單一登入記號
  14. 複製您的 SSO OAuth 權杖並將其貼至 Single Sign-On 權杖欄位中。
  15. 按一下測試端點。如果一切都正確,伺服器就會回應狀態 200,而您應該會在回應中看到 JSON 資料。

使用模擬資料測試 API 端點

您可以在 API 組態的設計階段,提供要求和回應訊息主體中的模擬資料。這可讓您檢查每個通話的相關資訊環境,而不需要使用即時資料或與即時服務互動。例如,若要測試您的程式碼是否正確處理無效的 ID,您可以在要求主體中新增包含無效 ID 之模擬資料的範例。完成測試之後,您可以將範例換成其他程式碼,以測試方法的其他部份層面。

在 FixItFast 範例中,回應主體中的模擬資料可讓您確認是否傳回正確的客戶資訊。以下是服務開發人員可以為 FixItFast 範例中 contact 資源之 POST 作業的回應主體建立的模擬資料範例:
{
 "id": 20934,
 "title": "Lynn's Leaking Water Heater",
       "contact": {
       "name": "Lynn Adams",
       "street": "45 O'Connor Street",
       "city": "Ottawa",
       "postalcode": "ala1a1"
       "username":"johneta"
       }
 "status": "new",
 "driveTime": 30,
 "priority": "high",
 "createdon": "2015-04-23 18:12:03 EDT"
}

建立自訂 API 時,會自動建立模擬實行。模擬實行可讓您在實行自訂程式碼之前,從行動應用程式呼叫 API。這可讓您同時開發及測試行動應用程式和自訂程式碼。如果您對組態感到滿意,可以新增真正的實行。

在您建立第一個實行之前,預設實行都是模擬實行。建立實際實行之後,就會成為 API 的預設實行。

按一下實行導覽連結,上傳實行或查看任何現有的實行。您可以在「實行 (Implementations)」頁面上變更預設實行。上傳實行之後,您會看到包含模擬實行的現有實行清單。

測試 REST 連線器 API

您現在已經定義 REST 連線器 API 並儲存組態,您將會想要確認能夠傳送要求並從 Web 服務收到預期的結果。測試連線是選擇性的步驟,但在完成連線器 API 之前,可以識別並修正問題來節省時間。「測試」頁面可讓您一次測試一個端點。

如果您提供描述區,則有兩種測試模式可供選擇:

  • 標準測試

    如果您提供描述區描述資料,則會顯示標準測試模式,其中會從描述性描述資料產生要求和回應主體,並顯示在要求回應頁籤中。您只需要針對 GET 方法選取要測試的參數,並包括要測試的任何 HTTP 標頭。

  • 進階測試

    您可以選取以進階模式測試 (提供遠端服務 URL 時所輸入的測試模式) 來縮小測試範圍。如果沒有描述性描述資料,您可以選取要測試的方法和資源、包含任何要包括的 HTTP 標頭,以及手動建立 JSON 主體。

以進階模式測試

進階測試頁面可讓您手動設定路徑參數、新增標頭,以及要求和回應有效負載。

手動設定連線器測試:

  1. 按一下測試導覽連結。
  2. 如果您提供描述區,請將以進階模式測試轉換成 On

    如果您提供遠端服務 URL,則進階測試頁面會自動顯示。

  3. 從下拉式清單中選取要測試的 HTTP 方法。
  4. 視需要在「本機 URI」欄位中指定任何資源路徑參數,以供測試之用。舉例而言:
    directions/json?origin=los+angeles&destination=seattle

    此欄位會自動加上您在輸入 API 名稱時所定義的本機 URI 作為字首。在我們的範例中,欄位的完整內容如下所示:

    myMapAPI /directions/json?origin=los+angeles&destination=seattle

    請注意,如果您定義任何規則,「套用的規則」欄位 (在「本文」欄位下方) 會顯示對應至適用於所選作業之規則的數字。「遠端 URL」欄位會顯示將傳送給測試服務的確切字串。

  5. 視需要新增一或多個要求或回應 HTTP 標頭。

    這些標頭僅供測試之用,不會新增至您的 REST 連線器 API 組態。

  6. 按一下 HTTP 主體欄位,即可在來源編輯器中建立訊息主體 (有效負載)。
    舉例而言:
    {
      "status":"ZERO_RESULTS",
      "routes":[ ]
    }

    保留與連線器用途相關的訊息主體內容,亦即,不要透過新增無關的資料來傳遞訊息。只在訊息本文中包含相關資料,有助於快速傳輸要求或回應。

  7. 如果您要連線的服務需要認證,請開啟認證段落,然後為您測試的每個方法輸入您的行動使用者證明資料。如果您使用的是預設測試證明資料,則可略過此步驟。

    使用以 SAML 為基礎的安全原則時,進行呼叫的使用者識別會傳輸至外部服務。對於其他安全原則 (例如 HTTP 基本認證和使用者名稱記號),原則中會以 CSF 金鑰覆寫用來向外部服務認證的證明資料。視您定義的作業而定,您可能必須為每項作業輸入特定的證明資料,或者您可以針對所有方法使用一組證明資料來向服務認證您的連線器。

  8. 按一下儲存為目前的行動後端預設證明資料,將您提供的使用者名稱和密碼儲存為預設值。
  9. 如果您在建立連線器的設計階段,而且只想查看您的端點是否有效,請按一下預設 API 設計工具測試證明資料,然後選取您註冊的行動後端與其版本號碼。
    您可以選擇性地輸入您的行動使用者證明資料 (使用者名稱和密碼)。

    這些預設測試證明資料會在您測試的所有方法中永久保存。在目前的行動中心階段作業期間,它們仍然有效。

  10. 按一下測試端點

    按一下測試端點即可切換為取消測試。如果您因任何原因而想要停止測試,請按一下取消測試

    按一下重設,清除欄位並修改測試參數。

  11. 完成端點測試之後,請按一下完成