2.4. API Designer での API 定義の表示(任意)
API Designer を使用して、OpenAPI(Swagger)形式の新しい API 定義を作成できます。API Designer を使用して、既存の API 定義を表示し、編集することもできます。Fuse Online インテグレーションを構築するための開始点として API Designer を作成またはインポートする API を使用できます。
このタスクは、API Designer を使用して Task Management API パス、操作、およびデータタイプ(API 仕様の作成または編集が行われないため)を行うため、任意となります。API 仕様に慣れたら、API Designer を終了し、Fuse Online に戻り、他のクイックスタートファイル(TaskAPI-export.zip)で提供される事前にビルドされたインテグレーションをインポートします。
前提条件
- REST API を理解している。
-
「Task Management API プロバイダークイックスタートファイルのダウンロード」 の説明に従って、raw バージョンの
task-api.jsonファイルをダウンロードしている。
手順
以下の手順に従って、API Designer で API 定義を表示します。
- Fuse Online の左側のナビゲーションパネルで Integrations をクリックします。
- Create Integration をクリックします。
- Choose a connection ページで API Provider カードをクリックします。
-
ダウンロードした
task-api.jsonファイルの raw バージョンを Upload an OpenAPI file セクションにドラッグします。Fuse Online は、ファイルが正常にインポートされたメッセージを表示します。 Next をクリックします。
注記警告メッセージは無視しても問題ありません。
Review/Edit をクリックします。
API Designer で API が開きます。
API の構造を確認します。これには、以下のコンポーネントが含まれます。
-
Taskのデータ型 以下の操作が含まれる
/todoタスク:- 全タスクの一覧を取得します。
- タスクを作成します。
以下の操作が含まれる
/todo/{id}タスク:- ID 別にタスクを取得します。
- ID 別にタスクを更新します。
- ID 別にタスクを削除します。
-
この OpenAPI 仕様からインテグレーションを構築するのではなく、時間を節約するために、API Designer を終了し、Fuse Online に戻り、「Task Management API プロバイダークイックスタートファイルのダウンロード」 でダウンロードした他のクイックスタートファイル(
TaskAPI-export.zip)で提供される事前にビルドされたインテグレーション全体をインポートできます。API Designer を終了するには、Cancel を 3 回クリックし、Fuse Online ダッシュボードに戻るまでキャンセルを 確認 します。