Warning

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

新しいオントロジー SDK TypeScript アプリケーションのブートストラップ

このページでは、@osdk/create-app CLI ツールを使用して、人気のある JavaScript フレームワークの上にフロントエンドアプリケーションを作成するプロセスを説明します。

既存のアプリケーションにオントロジー SDK のサポートを追加したい場合は、既存のアプリケーションにオントロジー SDK を追加するに関するドキュメンテーションをご覧ください。

1: 前提条件

Developer Console アプリケーションの作成

新しい Developer Console アプリケーションを作成するページに記載の手順に従ってください。

トークンの設定

ローカル環境でトークンをエクスポートします。以下はサンプルのパーソナルアクセストークンを使用した例ですが、Developer Console でより長い期間有効なものを生成することができます。このトークンはユーザーのパーソナルアクセストークンであるため、ソースコントロールにはチェックインしないでください。

Copied!
1 2 # 以下のコマンドは、環境変数FOUNDRY_TOKENに<YOUR-TOKEN-FROM-GETTING-STARTED-PAGE>を設定します。 export FOUNDRY_TOKEN=<YOUR-TOKEN-FROM-GETTING-STARTED-PAGE>

Node バージョンの確認

Typescript SDK は、Node 18 以降が必要です。使用している Node のバージョンを確認するには、以下のコマンドを入力してください。

Copied!
1 node --version # Node.jsのバージョンを表示する

2. @osdk/create-appを使ったクイックスタート

フロントエンドアプリケーションの作成

提供されたコマンドを実行し、対話式のプロンプトに従ってプロジェクトをカスタマイズします。これには、プロジェクト名やフレームワークの選択が含まれます。はじめに ページでは、コマンドに予め入力されるアプリケーション固有の情報を見つけることができます。以下にこのコードの例を示します。< >の中にはユーザーの具体的な詳細が入ります:

Copied!
1 2 3 4 5 6 7 8 9 10 # npm create コマンドで最新の @osdk/app を作成します # 以下のオプションを適切な値に置き換えてください npm create @osdk/app@latest -- \ --application <開発者コンソールアプリのRID> \ --foundryUrl <ファウンドリのURL> \ --applicationUrl <ファウンドリURLのサブドメイン(ホスティングに使用)> \ --clientId <クライアントID> \ --osdkPackage <パッケージ名> \ --osdkRegistryUrl <パッケージホスティングURL> \ --corsProxy false

これらのパラメーターを全て含む事前に入力済みのコマンドは、Developer Console の API Documentation セクションの Getting Started ページ、または Overview ページにあります。

フロントエンドアプリケーションの開発

ユーザーが入力したプロジェクト名に基づいて、プロジェクトのファイルが生成されました。以下のコマンドを実行すると、ローカル開発サーバーが起動します:

Copied!
1 2 3 4 5 6 # プロジェクトディレクトリに移動 cd <project-directory> # npmパッケージをインストール npm install # 開発モードで実行 npm run dev