Torii API Console

လမ်းကြောင်းများကို စစ်ဆေးရန်၊ စမ်းသပ်မှုတောင်းဆိုချက်များ ပေးပို့ရန်၊ 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 ကို ဖော်ပြရပါမယ်။
• Browser စမ်းသပ်မှုမှာ CORS က ဒီ doc ကို origin လုပ်ခွင့်ပြုဖို့ လိုအပ်ပါတယ်။
• Browser က Endpoint ကို တိုက်ရိုက်ရောက်ရှိနိုင်ဖို့ လိုပါတယ်။
• ကုဒ်ထုတ်လုပ်မှု လိုအပ်ချက် Node.js, pnpm, ပြီးတော့ Java Runtime ကို OpenAPI Generator ကို။

Console ကို default ကနေ https://taira.sora.org. ဒေသတွင်းဖွံ့ဖြိုးတိုးတက်ရေးမှာ ပုံမှန်အားဖြင့် http://127.0.0.1:8080 သင် ပြေးတဲ့အခါ Torii သင့်စက်ပေါ်မှာပါ။

Taira ကို အရင် စမ်းကြည့်ပါ။

Client ကို မဖန်တီးခင် အများပြည်သူ 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

ပြီးရင် paste လုပ်ပါ။ https://taira.sora.org/openapi.json Console ထဲကို ဝင်ပြီး read only route ကို စမ်းကြည့်ပါ။ ဥပမာ GET /status, GET /v1/domains, ဒါမှမဟုတ် GET /v1/assets/definitions. လက်မှတ်ရေးထိုးထားသော ငွေပေးချေမှုနှင့် ပုဂ္ဂလိက သော့စီးကြောင်းများကို SDK ဒါမှမဟုတ် CLI သင့်ရဲ့ Runtime ပတ်ဝန်းကျင်က လျှို့ဝှက်ချက်တွေကို တင်တဲ့ ဖောက်သည်ပါ။

ထုတ်လုပ်သော ဖောက်သည်များ

Generator command မှာ console က load လုပ်နေတဲ့ live OpenAPI စာရွက်စာတမ်းကိုပဲ သုံးပါတယ်။ ဒါက JSON operator, explorer, app နဲ့ telemetry routes တွေအတွက် အသုံးဝင်ပါတယ်။

လက်မှတ်ရေးထိုးထားသော စာရင်းအင်းလုပ်ငန်းများ၊ လက်မှတ်ရေးဆွဲထားသော မေးမြန်းချက်များနှင့် Norito - ဒေသခံ အသုံးဝင် ဝန်ဆောင်မှုများအတွက် တရားဝင် Iroha SDKs ကို ဦးစားပေးပါ။ OpenAPI ဖောက်သည်များသည်လက်မှတ်များကိုစုဆောင်းခြင်း၊ အကောင့်ဖိုင်များကို စီမံခန့်ခွဲခြင်း သို့မဟုတ် Norito ငွေချေးငွေအဖွဲ့အစည်းများကို သင်အတွက်ကုဒ်မပေးခြင်းမရှိပါ။

OpenAPI Generator ကိုထောက်ပံ့တဲ့ generator တစ်ခုစီကို စစ်ဆေးဖို့ Run:

pnpm dlx @openapitools/openapi-generator-cli list