Поделиться через


Структура документации по REST API Fabric

REST API Microsoft Fabric разработаны, чтобы помочь разработчикам автоматизировать Fabric. Справочные страницы REST API Fabric (документация) структурированы, чтобы помочь разработчикам найти необходимые сведения.

Эталонные страницы разделены на два основных раздела:

  • Основные API — основные API предоставляют сведения и функциональные возможности для всех элементов в Microsoft Fabric. Основные API не относятся к одной рабочей нагрузке и могут использоваться во всех рабочих нагрузках. Основные API— это API создания, чтения, обновления и удаления (CRUD). Их можно использовать для создания или обновления элементов Fabric вместе с общими свойствами. Основные API можно использовать при выполнении пакетных операций, которые не принудительно выполняют манипуляции с любым свойством, характерным для определенного типа элемента.

  • API рабочей нагрузки — API рабочей нагрузки предназначены для определенного типа элемента в Fabric.

Основные разделы и разделы справочных страниц рабочей нагрузки перечисляют все API в алфавитном порядке. Каждый раздел содержит обзор, содержащий список всех API в разделе и алфавитный список API в разделе.

Ввод данных для конкретного элемента

В разделе для конкретного элемента подробно описаны особенности каждого типа элемента в Fabric. Каждая запись типа элемента содержит следующее:

  • Обзор: краткое описание типа элемента.

  • Конечные точки: перечисляет доступные конечные точки для типа элемента, а также сведения о параметрах, форматах запросов и ответах и примерах.

  • Модели. Определяет модель данных для типа элемента, указывая свойства и типы.

  • Действия. Перечисляет доступные действия для типа элемента, включая сведения о параметрах, форматах запросов и ответах и примерах.

Используйте запись для конкретного элемента, чтобы понять уникальные аспекты API, связанные с определенным типом элемента, и рекомендации по выполнению операций, связанных с этим типом элемента.

Структура эталонной страницы

Каждая эталонная страница содержит следующие разделы:

  • Обзор . Короткий абзац в верхней части статьи, описывающей API.

  • Разрешения — список разрешений пользователя, необходимых для вызова API.

  • Требуемая область — список разрешений (также известных как области) для API.

  • Ограничения — (необязательно) Список ограничений для API.

  • Интерфейс — отображает форму HTTP API.

  • Параметры URI — список параметров, используемых для идентификации определенного ресурса или ресурсов.

  • Текст запроса — список свойств, которые можно передать в API.

  • Ответы — список возможных ответов из API.

  • Примеры — список примеров , демонстрирующих использование API.

  • Определения — параметры, определяющие структуру и свойства объекта, который можно передать в API.

Новая справочная структура документации по API предназначена для предоставления четкого и согласованного способа доступа и использования сведений API. Разделив раздел CORE и запись конкретного элемента, мы надеемся упростить поиск и использование сведений, необходимых для интеграции со службой Microsoft Fabric.

Мы приветствуем ваши отзывы и предложения по улучшению документации и API.