Skip to content

קונסולה Torii API

השתמשו במסמך OpenAPI חי מנקודת קצה פועלת Torii לבחון דרכים, לשלוח בקשות בדיקות, להעתיק פקודות curl ולייצר קוד לקלינט.

Load a running Torii endpoint to inspect and test its live OpenAPI routes.

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, ו- Java runtime עבור OpenAPI Generator.

הקונסולה מקובלת ל https://taira.sora.org. פיתוח מקומי בדרך כלל עובד עם http://127.0.0.1:8080 כאשר אתה פועל Torii במחשב שלך.

נסה קודם Taira

לפני יצירת קלינט, בדוק אם המסמך הציבורי OpenAPI נגיש מהמכשיר שלך:

bash
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 גנרטר, תפעילו:

bash
pnpm dlx @openapitools/openapi-generator-cli list