Console Torii API

Utilisez le document OpenAPI en direct depuis un point d'exécution Torii pour inspecter les itinéraires, envoyer des demandes de test, copier les commandes curl et générer du code client.

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.

Les exigences

• Le point final Torii doit exposer /openapi.json.
• Le test du navigateur nécessite CORS pour permettre l'origine de ce document.
• Le navigateur doit être en mesure d'atteindre directement le point final.
• La génération de code nécessite Node.js, pnpm, et un temps d'exécution Java pour le générateur OpenAPI.

La console est par défaut https://taira.sora.org. Le développement local fonctionne généralement avec http://127.0.0.1:8080 lorsque vous exécutez Torii sur votre machine.

Essayez d'abord Taira

Avant de générer un client, vérifiez que le document public OpenAPI est accessible à partir de votre machine:

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

Ensuite, collez https://taira.sora.org/openapi.json dans la console et essayez un itinéraire à lecture seule tel que GET /status, GET /v1/domains ou GET /v1/assets/definitions. Enregistrez les transactions signées et les flux de clés privées pour un client SDK ou CLI qui charge des secrets de votre environnement d'exécution.

Clients générés

La commande du générateur utilise le même live OpenAPI le document qui est chargé par la console. JSON l'opérateur, l'explorateur, les applications et les itinéraires de télémétrie.

Pour les transactions de registre signées, les requêtes signées et les charges utiles natives Norito, préférer le Iroha officiel SDKs. Les clients OpenAPI ne rassemblent pas de signatures, ne gèrent pas de clés de compte ni n'encodent pour vous les entités de transaction Norito.

Pour inspecter tous les générateurs pris en charge par le générateur OpenAPI, exécuter:

pnpm dlx @openapitools/openapi-generator-cli list