Partager via

Structure de la documentation sur l’API REST Fabric

Les API REST Microsoft Fabric sont conçues pour aider les développeurs à automatiser Fabric. Les pages de référence de l’API REST Fabric (documentation) sont structurées pour aider les développeurs à trouver les informations dont ils ont besoin.

Les pages de référence sont divisées en deux sections principales :

  • API principales : les API principales fournissent des informations et des fonctionnalités pour tous les éléments de Microsoft Fabric. Les API principales ne sont pas spécifiques à une charge de travail et peuvent être utilisées dans toutes les charges de travail. Les API principales sont des API de création, de lecture, de mise à jour et de suppression (CRUD). Vous pouvez les utiliser pour créer ou mettre à jour des éléments Fabric en même temps que leurs propriétés communes. Les API principales peuvent être utilisées lors de l’exécution d’opérations par lots qui ne forcent pas la manipulation d’une propriété spécifique à un type d’élément particulier.

  • API de charge de travail : les API de charge de travail ciblent un type d’élément spécifique dans Fabric.

Les sections de la page de référence de base et de charge de travail répertorient toutes les API par ordre alphabétique. Chaque section contient une vue d’ensemble qui inclut une liste de toutes les API de la section et une liste alphabétique des API de la section.

Entrée spécifique à l’élément

La section spécifique à l’élément détaille les spécificités de chaque type d’élément dans Fabric. Chaque entrée de type d’élément contient :

  • Vue d’ensemble : brève description du type d’élément.

  • Points de terminaison : répertorie les points de terminaison disponibles pour le type d’élément, ainsi que des détails sur les paramètres, les formats de demande et de réponse et les exemples.

  • Modèles : définit le modèle de données pour le type d’élément, en spécifiant des propriétés et des types.

  • Actions : répertorie les actions disponibles pour le type d’élément, y compris des détails sur les paramètres, les formats de demande et de réponse, et des exemples.

Utilisez l’entrée spécifique à l’élément pour comprendre les aspects uniques de l’API liés à un type d’élément spécifique et pour obtenir des conseils sur l’exécution d’opérations liées à ce type d’élément.

Structure de page de référence

Chaque page de référence comporte les sections suivantes :

  • Vue d’ensemble : un court paragraphe en haut de l’article qui décrit l’API.

  • Autorisations : liste des autorisations utilisateur nécessaires pour appeler l’API.

  • Étendue requise : liste d’autorisations (également appelées étendues) dont l’API a besoin.

  • Limitations : (facultatif) Liste des limitations pour l’API.

  • Interface : affiche la forme HTTP de l’API.

  • Paramètres d’URI : liste des paramètres utilisés pour identifier une ressource ou des ressources spécifiques.

  • Corps de la requête : liste des propriétés qui peuvent être passées à l’API.

  • Réponses : liste des réponses possibles de l’API.

  • Exemples : liste d’exemples qui montrent comment utiliser l’API.

  • Définitions : paramètres qui définissent la structure et les propriétés d’un objet qui peuvent être transmis à l’API.

La nouvelle structure de référence de documentation de l’API est destinée à fournir un moyen clair et cohérent d’accéder aux informations de l’API et de les utiliser. En séparant la section CORE et l’entrée spécifique de l’élément, nous espérons faciliter la recherche et l’utilisation des informations dont ils ont besoin pour s’intégrer au service Microsoft Fabric.

Nous vous invitons à nous faire part de vos commentaires et suggestions sur la façon d’améliorer la documentation et l’API.

Contenu connexe

  • Last updated on