Torii API أجهزة التحكم

استخدم وثيقة OpenAPI الحية من نقطة نهاية تعمل Torii للتفتيش على الطرق وإرسال طلبات الاختبار ونسخ أوامر curl وإنشاء رمز العميل.

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 - الحمولة الفائدة الأصلية ، تفضل الرسمية Iroha SDKs. لا يقوم عملاء OpenAPI بتجميع توقيعات أو إدارة مفاتيح الحسابات ، أو تشفير أجسام المعاملات Norito لك. .

للتفتيش على كل مولد يدعمها مولد OpenAPI، قم بتشغيل:

pnpm dlx @openapitools/openapi-generator-cli list