產生包裝函式 API 規格與 Postman Collection

您可以使用區塊鏈 App 產生器來建立篩選的權杖和帳戶 / 識別端點規格檔案，以及相符的 Postman 集合。

確認 package.json 檔案包含 hardhat-plugin-obp-besu-wrapper-api，而且 Hardhat 組態會匯入它。選取產生的權杖套裝程式，其中包含資訊清單和編譯的權杖 / 帳戶使用者自建物件。此工具會從產生的清單中尋找組合的套裝軟體，並支援相容的匯入參照專案清單。它不會部署或啟動包裝函式 API 服務。包裝程式 API 服務已作為執行處理設定的一部分執行。

  1. 產生權杖和帳戶規格。
    1. 開啟開發人員工具，然後選取產生包裝程式 API 規格與 Postman Collection 。
    2. 在組態中，選取 Hardhat 專案、記號套裝程式以及專案內的輸出資料夾。
    3. 在對應中，複查權杖 API 和帳戶 / 識別 API。保持為將保留在端點規格中的每個方法選取產生包裝函式 API 。視需要編輯端點路徑。
    4. 選取產生即可寫入篩選過的記號和帳戶設定 JSON 檔案以及 Postman 集合。
  2. 新增 ORDS Swagger/OpenAPI 端點。
    1. 在對應檢視中，選取了 ORDS API 。此工具僅支援 ORDS API 輸入。
    2. 選取 ORDS Swagger/OpenAPI JSON 檔案。
    3. 再次產生包裝函式資產。
  3. 建立結合的 API，定義將所選記號或帳戶方法結合成一個包裝函式 API 端點的循序工作流程。
    1. 在對應中，為每個適用的方法選取用於組合 API 。
    2. 選取建立結合的 API 。
    3. 輸入結合的 API 名稱和端點路徑。
    4. 複查並重新排序選取的步驟。針對每個步驟，對應其要求有效負載來源欄位。
    5. 儲存合併的 API 草稿，然後選取產生。
  4. 在包裝程式 API 服務註冊規格。
    1. 確定包裝函式 API 服務正在執行中，然後選取部署頁籤。
    2. 選取產生的權杖規格、帳戶規格、這兩種規格，或提供自訂 JSON 主體。
    3. 輸入包裝函式 API 主機 URL。
    4. 選取一個 Oracle Blockchain Platform Besu 環境，要求即可重複使用其認證和 TLS 設定值。
    5. 複查登錄預覽並登錄選取的規格。

註冊會張貼至包裝函式 API 服務的 /register 端點。此工具可使用所選 Oracle Blockchain Platform 環境的專用 CA 路徑，或針對註冊要求明確的自行簽署設定；它不會部署服務本身。

疑難排解

條件 解決方式
遺漏使用者自建物件或清單 編譯選取的專案，並確認已產生 / 匯入的套件檔案存在。
未產生任何端點 請至少選取一個方法來產生包裝函式 API，或至少儲存一個有效的組合 API。
ORDS 產生失敗 提供 ORDS Swagger/OpenAPI JSON 檔案，並確認專案 Plug-in 支援 --ords-swagger 選項。檢查完整的 Plug-in 日誌，瞭解綱要或作業錯誤。
已拒絕合併 API 檢查 API 名稱 / 路徑、排序的步驟以及要求欄位對應，然後再次儲存草稿。
註冊無法使用 請先產生端點規格檔案，然後選取 Oracle Blockchain Platform Besu 環境並提供可連線的包裝函式 API 主機 URL。