Compartir a través de

Estructura de documentación de la API REST de Fabric

Las API REST de Microsoft Fabric están diseñadas para ayudar a los desarrolladores a automatizar Fabric. Las páginas de referencia de la API REST de Fabric (documentación) están estructuradas para ayudar a los desarrolladores a encontrar la información que necesitan.

Las páginas de referencia se dividen en dos secciones principales:

  • API principales : las API principales proporcionan información y funcionalidad para todos los elementos de Microsoft Fabric. Las API principales no son específicas de una carga de trabajo y se pueden usar en todas las cargas de trabajo. Las API principales son las API de creación, lectura, actualización y eliminación (CRUD). Puede usarlos para crear o actualizar elementos de Fabric junto con sus propiedades comunes. Las API principales se pueden usar al ejecutar operaciones por lotes que no fuerzan la manipulación de ninguna propiedad específica de un tipo de elemento determinado.

  • API de carga de trabajo : las API de carga de trabajo tienen como destino un tipo de elemento específico en Fabric.

Las secciones de la página de referencia principal y de carga de trabajo enumeran todas las API alfabéticamente. Cada sección contiene información general que incluye una lista de todas las API de la sección y una lista alfabética de las API de la sección.

Entrada específica del elemento

La sección específica del elemento detalla los detalles de cada tipo de elemento en Fabric. Cada entrada de tipo de elemento contiene:

  • Información general: una breve descripción del tipo de elemento.

  • Puntos de conexión: muestra los puntos de conexión disponibles para el tipo de elemento, junto con detalles sobre parámetros, formatos de solicitud y respuesta, y ejemplos.

  • Modelos: define el modelo de datos para el tipo de elemento, especificando propiedades y tipos.

  • Acciones: enumera las acciones disponibles para el tipo de elemento, incluidos detalles sobre parámetros, formatos de solicitud y respuesta, y ejemplos.

Use la entrada específica del elemento para comprender los aspectos únicos de la API relacionados con un tipo de elemento específico y para obtener instrucciones sobre cómo realizar operaciones relacionadas con ese tipo de elemento.

Estructura de página de referencia

Cada página de referencia tiene las secciones siguientes:

  • Información general : párrafo corto en la parte superior del artículo que describe la API.

  • Permisos: lista de permisos de usuario necesarios para llamar a la API.

  • Ámbito requerido : una lista de permisos (también conocidos como ámbitos) que requiere la API.

  • Limitaciones : (opcional) Lista de limitaciones de la API.

  • Interfaz: muestra el formato HTTP de la API.

  • Parámetros de URI : una lista de parámetros usados para identificar un recurso o recursos específicos.

  • Cuerpo de la solicitud : lista de propiedades que se pueden pasar a la API.

  • Respuestas : lista de posibles respuestas de la API.

  • Ejemplos : una lista de ejemplos que muestran cómo usar la API.

  • Definiciones : parámetros que definen la estructura y las propiedades de un objeto que se puede pasar a la API.

La nueva estructura de referencia de documentación de API está pensada para proporcionar una forma clara y coherente de acceder a la información de la API y usarla. Al separar la sección CORE y la entrada específica del elemento, esperamos facilitar a los desarrolladores encontrar y usar la información que necesitan para integrarse con el servicio Microsoft Fabric.

Agradecemos sus comentarios y sugerencias sobre cómo mejorar la documentación y la API.

Contenido relacionado

  • Last updated on