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- ի գործարկման ժամանակը 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 հաճախորդի համար:

Ստեղծված հաճախորդներ

Գեներատորի հրամանը օգտագործում է նույն կենդանի OpenAPI փաստաթուղթը, որը բեռնում է կոնսոլը: Սա օգտակար է JSON օպերատորների, Explorer- ի, հավելվածների եւ հեռաչափման ուղիների համար:

ստորագրված գրասենյակային գործարքների, ստորագրված հարցումների եւ Norito բնիկ օգտակար բեռների համար նախընտրեք պաշտոնական Iroha SDKs: OpenAPI հաճախորդները ձեզ համար չեն հավաքում ստորագրություններ, կառավարում են հաշիվի բանալիները կամ կոդավորում Norito գործարքի մարմինները:

OpenAPI գեներատորի կողմից աջակցվող յուրաքանչյուր գեերատորին ստուգելու համար գործարկեք:

pnpm dlx @openapitools/openapi-generator-cli list