Sdílet prostřednictvím

Struktura dokumentace k rozhraní REST API Fabric

Rozhraní REST API Microsoft Fabric jsou navržena tak, aby pomohla vývojářům automatizovat Fabric. Referenční stránky rozhraní REST API infrastruktury (dokumentace) jsou strukturované, aby vývojářům pomohly najít potřebné informace.

Referenční stránky jsou rozdělené do dvou hlavních oddílů:

  • Základní rozhraní API – Základní rozhraní API poskytují informace a funkce pro všechny položky v rámci Microsoft Fabric. Základní rozhraní API nejsou specifická pro jednu úlohu a dají se použít napříč všemi úlohami. Základní rozhraní API jsou rozhraní API pro vytváření, čtení, aktualizaci a odstraňování (CRUD). Můžete je použít k vytváření nebo aktualizaci prvků Fabric spolu s jejich běžnými vlastnostmi. Základní rozhraní API je možné použít při provádění dávkových operací, které nevynucují manipulaci s žádnou vlastností specifickou pro konkrétní typ položky.

  • Rozhraní API pro pracovní zátěž – Rozhraní API pro pracovní zátěž cílí na konkrétní typ položky v platformě Fabric.

Oddíly základních stránek a referenčních stránek úloh uvádějí všechna rozhraní API abecedně. Každý oddíl obsahuje přehled, který obsahuje seznam všech rozhraní API v oddílu a abecední seznam rozhraní API v této části.

Záznam specifický pro položku

Oddíl specifický pro jednotlivé položky podrobně popisuje specifika jednotlivých typů položek v Fabric. Každý záznam typu položky obsahuje:

  • Přehled: Stručný popis typu položky.

  • Koncové body: Uvádí dostupné koncové body pro typ položky spolu s podrobnostmi o parametrech, formátech požadavků a odpovědí a příkladech.

  • Modely: Definuje datový model pro typ položky a určuje vlastnosti a typy.

  • Akce: Zobrazí seznam dostupných akcí pro typ položky, včetně podrobností o parametrech, formátech požadavků a odpovědí a příkladech.

Položka specifická pro danou položku slouží k pochopení jedinečných aspektů rozhraní API souvisejících s konkrétním typem položky a pokyny k provádění operací souvisejících s daným typem položky.

Referenční struktura stránky

Každá referenční stránka obsahuje následující části:

  • Přehled – krátký odstavec v horní části článku, který popisuje rozhraní API.

  • Oprávnění – seznam uživatelských oprávnění potřebných pro volání rozhraní API.

  • Požadovaný obor – seznam oprávnění (označovaných také jako obory) vyžaduje rozhraní API.

  • Omezení – (volitelné) Seznam omezení pro rozhraní API

  • Rozhraní – zobrazí formulář HTTP rozhraní API.

  • Parametry URI – seznam parametrů použitých k identifikaci konkrétního prostředku nebo prostředků.

  • Text požadavku – seznam vlastností, které je možné předat do rozhraní API.

  • Odpovědi – seznam možných odpovědí z rozhraní API.

  • Příklady – seznam příkladů, které ukazují, jak používat rozhraní API.

  • Definice – Parametry, které definují strukturu a vlastnosti objektu, který lze předat rozhraní API.

Nová referenční struktura dokumentace k rozhraní API je určená k zajištění jasného a konzistentního způsobu přístupu a používání informací o rozhraní API. Oddělením oddílu CORE a položky specifické pro danou položku doufáme, že vývojářům usnadníme hledání a používání informací, které potřebují k integraci se službou Microsoft Fabric.

Vítáme vaše názory a návrhy na vylepšení dokumentace a rozhraní API.

Související obsah