新增 Swagger 定義作為同步化來源

使用 Swagger 定義來自動建立在測試定義所說明的 API 時所需的資源。

關於這項作業

從 Swagger 定義產生的資源可包括作業和 Web 表單、JSON 和 URL 綱目。
當您同步化時,會包含 Swagger 定義中的基本鑑別和 API 金鑰的安全相關資訊。
基本鑑別
HTTP 傳輸是啟用「基本鑑別」來建立的。
API 金鑰
在與定義至少一個 API 金鑰的 Swagger 定義同步化之後,每個 API 金鑰安全保護方法都會建立一個環境標籤。 所建立各標籤的用法都取決於內容標頭或查詢中的安全保護方法。
  • 在含有環境標籤的相關作業中,會將標頭欄位建立為欄位預設值。
  • 在所產生含有環境標籤的 REST 綱目中,會將查詢區段建立為預設值。
OAuth2
不支援。

程序

  1. 依下列其中一種方式啟動「建立新的同步化來源」精靈:
    • 在「架構設計中心」視景的「同步化」視圖的工具列中,按一下 Web > Swagger 定義
    • 按一下建立同步化來源圖示 (),從類型清單中選取 Swagger 定義
    • 將指向 Swagger 定義的 URL 或檔案位置,貼到「邏輯視圖」的工作區中。
      註: 當 Swagger 定義檔的名稱不是 swagger.json 時,請開啟「同步化來源」精靈,並手動輸入完整路徑。
    這時會顯示「建立新的同步化來源」精靈。前往步驟 2
  2. 在「建立新的同步化來源」精靈的第一個頁面,填寫 Swagger 來源的特有資訊。
    精靈的第一個頁面
    該資訊包含要用作同步化來源的定義檔的位置:
    檔案
    按一下瀏覽以瀏覽至本端網路上的 Swagger 定義檔。
    URL
    在相關聯文字框中輸入指向 Swagger 定義檔的 URL。

    Swagger 定義可以是 JSON 或 YAML 格式。

  3. 依照新增同步化來源中的指示完成精靈。

意見