Torii API Консоль

Используйте живый OpenAPI документ из запускающегося конечного пункта Torii для проверки маршрутов, отправки тестовых запросов, копирования команд curl и генерации клиента.

Torii endpoint

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

Generate clientTypeScript fetchPythonRustKotlinJavaSwift

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, и Java runtime для генератора OpenAPI.

Консоль по умолчанию https://taira.sora.org. Локальная разработка обычно работает с http://127.0.0.1:8080, когда вы запускаете Torii на вашем компьютере.

Сначала попробуй Taira

Прежде чем создавать клиент, проверьте, доступен ли публичный документ OpenAPI с вашего компьютера:

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, запустить:

pnpm dlx @openapitools/openapi-generator-cli list