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 に設定されます. ローカル開発は通常,コンピュータ上で Torii を実行するときに http://127.0.0.1:8080 と動作します.

まず 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 を試してみてください

作成されたクライアント