Microsoft Fabric REST API は、開発者が Fabric を自動化できるように設計されています。 Fabric REST API リファレンス ページ (ドキュメント) は、開発者が必要な情報を見つけるのに役立つ構造になっています。
参照ページは、次の 2 つの主要なセクションに分かれています。
コア API - コア API は、Microsoft Fabric 内のすべての項目に関する情報と機能を提供します。 コア API は 1 つのワークロードに固有ではなく、すべてのワークロードで使用できます。 コア API は、作成、読み取り、更新、および削除 (CRUD) API です。 これらを使用して、共通プロパティと共に Fabric 項目を作成または更新できます。 コア API は、特定の項目の種類に固有のプロパティの操作を強制しないバッチ操作の実行中に使用できます。
ワークロード API - ワークロード API は、Fabric の特定の項目の種類を対象とします。
コアとワークロードのリファレンス ページのセクションには、すべての API がアルファベット順に一覧表示されます。 各セクションには、セクション内のすべての API の一覧と、セクション内の API のアルファベット順の一覧を含む概要が含まれています。
アイテム固有のエントリ
項目固有のセクションでは、Fabric の各項目の種類の詳細について説明します。 各項目の種類のエントリには、次のものが含まれます。
概要: 項目の種類の簡単な説明。
エンドポイント: 項目の種類に使用できるエンドポイントと、パラメーター、要求と応答の形式、および例の詳細を一覧表示します。
モデル: プロパティと型を指定して、項目の種類のデータ モデルを定義します。
アクション: パラメーター、要求と応答の形式、例の詳細など、項目の種類に対して使用可能なアクションを一覧表示します。
項目固有のエントリを使用して、特定の項目の種類に関連する API の固有の側面を理解し、その項目の種類に関連する操作の実行に関するガイダンスを提供します。
参照ページの構造
各参照ページには、次のセクションがあります。
概要 - API について説明する記事の上部にある短い段落。
アクセス許可 - API の呼び出しに必要なユーザーアクセス許可の一覧。
必要なスコープ - API に必要なアクセス許可の一覧 (スコープとも呼ばれます)。
制限事項 - (省略可能) API の制限事項の一覧。
インターフェイス - API の HTTP 形式を表示します。
URI パラメーター - 特定のリソースを識別するために使用されるパラメーターの一覧。
要求本文 - API に渡すことができるプロパティの一覧。
応答 - API からの可能な応答の一覧。
例 - API の使用方法を示す例の一覧。
定義 - API に渡すことができるオブジェクトの構造とプロパティを定義するパラメーター。
新しい API ドキュメント参照構造は、API 情報にアクセスして使用するための明確で一貫性のある方法を提供することを目的としています。 CORE セクションと項目固有のエントリを分離することで、開発者が Microsoft Fabric サービスと統合するために必要な情報を簡単に見つけて使用できるようにしたいと考えています。
ドキュメントと API を改善する方法に関するフィードバックと提案をお待ちしております。