کنسول Torii API

راستوں کا معائنہ کرنے، ٹیسٹ کی درخواستیں بھیجنے، curl کمانڈز کو کاپی کرنے اور کلائنٹ کوڈ پیدا کرنے کے لئے چلنے والے Torii اختتامی نقطہ سے براہ راست OpenAPI دستاویز کا استعمال کریں۔

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، اور ایک جاوا رن ٹائم کی ضرورت ہے 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 - مقامی مفید بوجھ کے ل the ، سرکاری Iroha SDKs کو ترجیح دیں۔ OpenAPI کلائنٹ آپ کے لئے دستخط جمع نہیں کرتے ہیں ، اکاؤنٹ کی چابیاں سنبھالتے ہیں ، یا Norito ٹرانزیکtionشن اداروں کو کوڈ کرتے ہیں۔

OpenAPI جنریٹر کی حمایت سے ہر جنریٹر کا معائنہ کرنے کے لئے، چلائیں:

pnpm dlx @openapitools/openapi-generator-cli list