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 და Java runtime for OpenAPI Generator.

კონსოლი დეფოლუტურად 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 კლიენტისთვის, რომელიც ატვირთავს საიდუმლოებებს თქვენი runtime გარემოსგან.

შექმნილი კლიენტები

გენერატორის ბრძანება იყენებს იმავე ცოცხალ OpenAPI დოკუმენტს, რომელიც დატვირთულია კონსოლზე. ეს სასარგებლოა JSON ოპერატორისთვის, ექსპლუზერისთვის, აპლიკაციისთვის და ტელემეტრიის მარშრუტებისთვის.

ხელმოწერილი ლიდერული ტრანზაქციების, ხელმოწერილ გამოკითხვების და Norito-მშობელი სასარგებლო ტვირთებისათვის, უპირატესობა აქვს ოფიციალურ Iroha SDKs. OpenAPI კლიენტები არ შეაგროვებენ ხელმოწერებს, მართავენ ანგარიშის გასაღებს ან კოდირებენ Norito სატრანზაქციის ორგანოებს თქვენთვის.

ყველა OpenAPI გენერატორის მიერ მხარდაჭერილი გენერაციის ინსპექტირებისათვის, გაუშვით:

pnpm dlx @openapitools/openapi-generator-cli list