Fabric REST API 文档结构

Microsoft Fabric REST API 旨在帮助开发人员自动执行 Fabric。 Fabric REST API 参考页(文档)有助于开发人员找到所需的信息。

参考页分为两个主要部分:

  • 核心 API - 核心 API 为 Microsoft Fabric 中的所有项提供信息和功能。 核心 API 不特定于一个工作负荷,可用于所有工作负荷。 核心 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 的反馈和建议。