注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。
新しい Developer Console アプリケーションを作成する
このページでは、新しい Developer Console アプリケーションを作成するための以下のプロセスを説明します:
- オブジェクトタイプ、アクションタイプ、およびその他のオントロジーリソースを SDK アプリケーションに追加する。
- プラットフォーム API アクセスのための操作とリソースを追加する。
- サポートされているいずれかの言語でパッケージを生成する。
- アプリケーション専用の SDK 用に生成されたカスタムドキュメントを使用する。
Developer Console を使用してアプリケーションを作成する
Foundry インスタンスで Developer Console に移動 し、+ New application を選択します。
+ New application ボタンが表示されない場合は、追加の権限が必要です。詳細は 権限に関するドキュメント を参照してください。
次に、表示される作成ウィザードの手順に従い、以下の詳細を追加してください:
- Basic information ページで、アプリケーションにアイコンを追加します。アイコンは、ユーザーが同意画面を表示されたときにアプリケーションを識別するために使用されます。
- Application type ページで、Client-facing application を選択します。
- Permissions ページの Authorization code grant セクションで、リダイレクト URL を
http://localhost:8080/auth/callbackに設定します。
Configure CORS の指示に従い、http://localhost:8080 を Control Panel の CORS ポリシーに追加してください。CORS を設定する権限がなく、Foundry 管理者も CORS を設定できない場合は、リダイレクト URL を https://localhost:8080/auth/callback に設定してください。
リソース
- Resources ページで、Yes, generate an Ontology SDK を選択します。
- 使用するオントロジーを選択します。次に、オントロジー SDK パッケージに含めたいオブジェクトタイプとアクションタイプを選択します。この演習では、利用可能な任意のオブジェクトタイプを選択してください。
選択したデータエンティティは、アプリケーションの 2 つの側面を制御します:
- 生成されたタイプ: 言語固有のバインディングは、選択されたエンティティに基づいて作成されます。さらに、統合された API ドキュメントは、選択に基づいて生成されます。
- アプリケーショントークン: OAuth 2.0 フローを経て受け取るトークンは、デフォルトで選択したエンティティのセットにスコープされます。詳細については、リソースアクセススコープ を参照してください。
- アプリケーションを使用して プラットフォーム API リクエスト を行う必要がある場合は、Platform SDK タブを介して適切なリソースと操作を追加してください。
Client allowed operations テーブルで許可された操作により、アプリケーションが基盤となるサービスエンドポイントにアクセスできる場合があります。
- 入力した情報を確認し、Create application を選択してアプリケーションを作成します。
- 最後に、Generate first version を選択して、作成されたパッケージの最初のバージョンを取得する必要があります。
オントロジー固有のドキュメント
Developer Console は、選択したオントロジーエンティティに基づいてドキュメントを生成します。このドキュメントは TypeScript、Python、cURL で利用可能です。コンソールの右上隅にあるドロップダウンメニューを使用して、異なる言語間を切り替えることができます。
上の例では、各オブジェクトタイプ、アクションタイプ、および関数が文書化されています。ドキュメントには、特定のプロパティがどのように返されるか、またはパラメーターがどのように使用できるかのコード例が含まれています。これらの例をコピーしてコードに直接貼り付けることができます。