Torii API Konsol

Yolları yoxlamaq, test tələbləri göndərmək, curl əmrlərini kopyalamaq və müştəri kodu yaratmaq üçün işləyən Torii son nöqtəsindən canlı OpenAPI sənədindən istifadə edin.

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.

Tələbi

• Torii son nöqtəsi /openapi.json ifşa etməlidir.
• Browser testləri CORS bu sənədlərin mənşəyini təmin etmək üçün tələb edir.
• Brauzer birbaşa son nöqtəyə çatmaq imkanına malik olmalıdır.
• Kodu istehsal etmək üçün Node.js, pnpm və OpenAPI Generator üçün Java işləmə vaxtı lazımdır.

Konsol standart olaraq https://taira.sora.org. Yerli inkişaf ümumiyyətlə kompüterdə Torii çalışdığınız zaman http://127.0.0.1:8080 ilə işləyir.

Əvvəlcə Taira sınayın

Bir müştəri yaratmadan əvvəl, ictimai OpenAPI sənədin maşınınızdan əldə edilə biləcəyini yoxlayın:

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

Sonra konsolla https://taira.sora.org/openapi.json əlavə edin və GET /status, GET /v1/domains və ya GET /v1/assets/definitions kimi yalnız oxunma yolu sınayın. İşlənmiş əməliyyatı və şəxsi açar axınlarını iş vaxtı mühitinizdən sirləri yükləyən SDK və ya CLI müştəri üçün saxlayın.

Yaradılmış Müştərilər

Generator komandanı konsol yüklədiyi eyni canlı OpenAPI sənədi istifadə edir. Bu, JSON operatoru, kəşfiyyatçısı, tətbiq və telemetri marşrutu üçün faydalıdır.

İmzalanmış nəşriyyat əməliyyatları, imzalanan sorğular və Norito - yerli payloadlar üçün rəsmi Iroha SDKs istifadəçiləri üstünlük verirlər. OpenAPI müştərilər sizin üçün imzaları toplamazlar, hesab açarlarını idarə etmirlər və ya Norito əməliyyat orqanlarını kodlamırlar. .

OpenAPI Generator tərəfindən dəstəklənən hər bir generatorun yoxlanılmasına görə:

pnpm dlx @openapitools/openapi-generator-cli list