Con el uso de la consola Torii API

Utilice el documento OpenAPI en vivo desde un punto final Torii en ejecución para inspeccionar las rutas, enviar solicitudes de prueba, copiar los comandos curl y generar código cliente.

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.

Requisitos

• El punto final Torii deberá exponer el /openapi.json.
• Las pruebas del navegador requieren CORS para permitir el origen de este documento.
• El navegador debe ser capaz de llegar directamente al punto final.
• La generación de código requiere Node.js, pnpm, y un tiempo de ejecución Java para el generador OpenAPI.

La consola se configura por defecto en https://taira.sora.org. El desarrollo local generalmente funciona con http://127.0.0.1:8080 cuando ejecuta Torii en su máquina.

Prueba primero Taira

Antes de generar un cliente, compruebe si el documento público OpenAPI se puede acceder desde su máquina:

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

Luego ponga https://taira.sora.org/openapi.json en la consola y pruebe una ruta de sólo lectura como GET /status, GET /v1/domains o GET /v1/assets/definitions. Guarde transacciones firmadas y flujos de llaves privadas para un cliente SDK o CLI que cargue secretos de su entorno de tiempo de ejecución. .

Los clientes generados

El comando del generador utiliza el mismo documento en vivo OpenAPI que la consola carga. Esto es útil para el operador, explorador, aplicación y rutas de telemetría JSON.

Para las transacciones firmadas en el libro mayor, consultas firmadas, y Norito- las cargas útiles nativas, prefieren el oficial Iroha SDKs. OpenAPI Los clientes no reúnen firmas, gestionan llaves de cuenta o codifican. Norito los organismos de transacciones para usted.

Para inspeccionar todos los generadores compatibles con el generador OpenAPI, ejecute:

pnpm dlx @openapitools/openapi-generator-cli list