メインコンテンツまでスキップ

NodeWatch OpenAPI クライアント作成

NodeWatch は、Symbol ノードと NEM ノードの監視と管理を行うためのツールです。 NodeWatch は OpenAPI 仕様に基づいており、API クライアントを自動生成することができます。 このドキュメントでは、NodeWatch の OpenAPI クライアントを作成する手順を説明します。

openapi-generator-cli のインストール​

NodeWatch の OpenAPI クライアントを生成するために、openapi-generator-cli を使用します。 以下のコマンドを実行して、openapi-generator-cli をインストールします。

npm install @openapitools/openapi-generator-cli -g

OpenAPI 仕様の取得​

NodeWatch の OpenAPI 仕様を取得するために、以下のコマンドを実行します。

NodeWatch API Documentation

curl -O https://nodewatch.symbol.tools/static/openapi/openapi.yaml

TypeScript​

TypeScript クライアントの生成​

以下のコマンドを実行して、TypeScript クライアントを生成します。

openapi-generator-cli generate \
  -i openapi.yaml \
  -g typescript-axios \
  -o ./nodewatch-client