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 генераторы өсөн Java-ҡаҡшы ваҡыт кәрәк.

Консоль ҡалып буйынса https://taira.sora.org. урындағы үҫеш, ғәҙәттә, һеҙҙең машинаһында 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 операторы, Explorer, ҡушымта һәм телеметрия маршруттары өсөн файҙалы.

Ҡул ҡуйылған операциялар өсөн, ҡул ҡуйылған һорауҙар һәм Norito- урындағы файҙалы йөкләмәләр, рәсми хеҙмәткә өҫтөнлөк биреү Iroha SDKs. OpenAPI клиенттар ҡултамғалар йыя алмай, иҫәп-хисап асҡыстары менән идара итмәй һәм кодламай Norito һеҙҙең өсөн транзакция органдары.

OpenAPI генераторы менән тәьмин ителгән һәр генераторҙы тикшереү өсөн түбәндәгеләрҙе эшләй:

pnpm dlx @openapitools/openapi-generator-cli list