Torii API 控制檯

使用從運行 Torii 終端點的直播 OpenAPI 文檔來檢查路線,發送測試請求,複製 curl 指令並生成客戶端代碼.

Load a running Torii endpoint to inspect and test its live OpenAPI routes.

Generate client

export TORII_URL=https://taira.sora.org
node --input-type=module <<'EOF' > iroha-torii.openapi.json
const toriiUrl = process.env.TORII_URL
const response = await fetch(`${toriiUrl}/openapi.json`)
if (!response.ok) throw new Error(`HTTP ${response.status}`)
const spec = await response.json()
spec.servers = [{ url: toriiUrl, description: 'Selected Torii endpoint' }]
console.log(JSON.stringify(spec, null, 2))
EOF

pnpm dlx @openapitools/openapi-generator-cli generate
  -i iroha-torii.openapi.json \
  -g typescript-fetch \
  -o ./iroha-torii-typescript

Generated OpenAPI clients are best for JSON operator and app routes. Use the Iroha SDKs for signed ledger transactions, signed queries, and Norito-native payloads.

要求

Torii 終端點必須暴露/openapi.json.
瀏覽器測試需要 CORS 才能允許此文檔的來源.
瀏覽器必須能夠直接到達終點.
代碼生成需要 Node.js, pnpm,以及 OpenAPI 發電機的Java運行時間.

默認的控制檯爲 https://taira.sora.org. 地方發展通常與 http://127.0.0.1:8080 當你跑步時 Torii 在你的機器上.

首先試看 Taira

在生成客戶端之前,請檢查公開 OpenAPI 文件是否可以從您的機器中訪問:

bash

curl -fsS https://taira.sora.org/openapi.json -o /tmp/taira-openapi.json
jq '{title: .info.title, version: .info.version, paths: (.paths | length)}' \
  /tmp/taira-openapi.json

然後將 https://taira.sora.org/openapi.json 粘貼到控制檯中,然後嘗試閱讀式路線,如GET /status, GET /v1/domains或 GET /v1/assets/definitions.爲您的運行環境中的祕密加載的 SDK 或 CLI 客戶端保存簽署的交易和私鑰流動.

產生的客戶

生成器命令使用控制檯加載的同一個直播 OpenAPI 文檔.這對於 JSON 操作員,探索者,應用程序和遠程測量路線來說有用.

對於簽署的賬本交易,簽署的查詢和 Norito-原生有效載荷,更喜歡官方的 Iroha SDKs. OpenAPI 客戶端不爲您組裝簽名,管理帳戶密鑰或編碼 Norito 交易機構.

要檢查每個由 OpenAPI 發電機支持的發電器,運行:

bash

pnpm dlx @openapitools/openapi-generator-cli list

Torii API 控制檯 ​

要求 ​

首先試看 Taira ​

產生的客戶 ​

Torii API 控制檯

要求

首先試看 Taira

產生的客戶