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-ийг илрүүлнэ.
• Бrowser-ийн шинжилгээ нь CORS нь энэ баримтын эх үүсвэрийг зөвшөөрөх шаардлагатай юм.
• Бrowser нь төгсгөлийн цэгт шууд хүрэх боломжтой байх ёстой.
• Код үүсгэхэд 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 оператор, судлаач, апп болон телеметрийн замаар ашигтай юм.

Гарын үсэг зурсан номын сангийн гүйлгээ, гарын үсэг зурасан асуултууд, Norito - үндсэн ашиг ачааллын хувьд албан ёсны Iroha SDKs хэрэглэгчдийг сонгоно. OpenAPI үйлчлүүлэгчид танд гарын үсгийн цуглуулж, дансны түлхүүр удирдахгүй, эсвэл Norito гүйлгээний байгууллагыг кодлахгүй.

OpenAPI генераторд дэмжлэг үзүүлдэг бүх генераторийг шалгахын тулд:

pnpm dlx @openapitools/openapi-generator-cli list