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 генераторы үшін Java орындау уақытын қажет етеді.

Консоль әдетті түрде https://taira.sora.org. Жергiлiктi даму, әдетте, сіздің машинаңызда Torii орындалған кезде http://127.0.0.1:8080мен жұмыс істейді.

Алдымен 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