Torii API Consola

Use o documento OpenAPI ao vivo de um endpoint Torii em execução para inspecionar as rotas, enviar pedidos de teste, copiar os comandos curl e gerar código do 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

• O ponto final Torii deve exponer o /openapi.json.
• Os testes de navegador exigem CORS para permitir a origem deste documento.
• O navegador deve ser capaz de atingir directamente o ponto final.
• A geração de código requer Node.js, pnpm, e um tempo de execução Java para o gerador OpenAPI.

O console é padrão para https://taira.sora.org. Desenvolvimento local geralmente funciona com http://127.0.0.1:8080 quando você executa Torii em sua máquina.

Tente Taira Primeiro.

Antes de gerar um cliente, verifique se o documento público OpenAPI é acessível a partir da sua 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

Em seguida, coloque https://taira.sora.org/openapi.json no console e tente uma rota de somente leitura como GET /status, GET /v1/domains ou GET /v1/assets/definitions. Salve transações assinadas e fluxos de chaves privadas para um cliente SDK ou CLI que carrega segredos do seu ambiente de execução.

Clientes gerados

O comando do gerador usa o mesmo ao vivo OpenAPI O documento que o console carrega. JSON operadores, exploradores, aplicativos e rotas de telemetria.

Para transações de contabilidade assinadas, consultas assinadas e cargas úteis nativas Norito, prefira-se o oficial Iroha SDKs. Os clientes OpenAPI não montam assinaturas, gerenciam chaves de contas ou codificam corpos de transação Norito para você.

Para inspeccionar todos os geradores suportados pelo gerador OpenAPI, executar:

pnpm dlx @openapitools/openapi-generator-cli list