Torii API konsol

Yo'nalishlarni tekshirish, sinov so'rovlarini yuborish, curl buyruqlarini nusxalash va mijoz kodini yaratish uchun ishlatiladigan Torii oxirgi nuqtadan jonli OpenAPI hujjatidan foydalaning.

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.

Talablar

• Torii oxirgi nuqtasi /openapi.json ni ko'rsatishi kerak.
• Ushbu hujjatlarning kelib chiqishiga ruxsat berish uchun brauzer sinovlari CORS ni talab qiladi.
• Brauzer to'g'ridan-to'g'ri oxirgi nuqtaga yetib borishi kerak.
• Kod ishlab chiqarish uchun Node.js, pnpm va OpenAPI generator uchun Java ishga tushirish vaqti kerak.

Konsol andoza https://taira.sora.org. Mahalliy rivojlanish odatda http://127.0.0.1:8080 bilan ishlaydi, siz mashinangizda Torii ishga tushirganingizda.

Avvalo Taira ni sinab ko'ring

Mijoz yaratishdan oldin, ommaviy OpenAPI hujjatini mashinangizdan olish mumkinligini tekshiring:

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

Keyin https://taira.sora.org/openapi.json ni konsolga qo'yib, GET /status, GET /v1/domains yoki GET /v1/assets/definitions kabi o'qish uchun mo'ljallangan yo'lni sinab ko'ring. O'zingizning ish vaqti muhitingizdan sirlarni yuklaydigan SDK yoki CLI mijozi uchun imzolangan tranzaksiya va xususiy kalit oqimlarini saqlash.

Ishlab chiqarilgan mijozlar

Generator buyruqida konsol yuklaydigan bir xil jonli OpenAPI hujjati ishlatiladi. Bu JSON operatori, qidiruvchisi, dastur va telemetriya yo'nalishlari uchun foydali.

Imzolangan katta qog'ozlar tranzaksiyalari, imzolangan so'rovlar va Norito natijali faydali yuklar uchun rasmiy Iroha SDKs ni afzal ko'rish kerak. OpenAPI mijozlar siz uchun imzolarni yig'maydilar, hisob kalitlarini boshqarmaydilar yoki Norito tranzaksiyalar organlarini kodlamaydilar.

OpenAPI generator tomonidan qo'llab-quvvatlanadigan har bir generatorni tekshirish uchun quyidagilarni o'tkazing:

pnpm dlx @openapitools/openapi-generator-cli list