Megosztás:

Fabric REST API dokumentációs struktúrája

A Microsoft Fabric REST API-kat úgy tervezték, hogy segítsenek a fejlesztőknek a Fabric automatizálásában. A Fabric REST API referenciaoldalai (dokumentációja) úgy vannak strukturálva, hogy segítsenek a fejlesztőknek megtalálni a szükséges információkat.

A referencialapok két fő szakaszra vannak osztva:

  • Alapvető API-k – A Core API-k információkat és funkciókat biztosítanak a Microsoft Fabric összes eleméhez. Az alapvető API-k nem egyetlen számítási feladatra vonatkoznak, és minden számítási feladathoz használhatók. Az alapvető API-k a létrehozási, olvasási, frissítési és törlési (CRUD) API-k. Használhatja őket Fabric elemek létrehozására vagy frissítésére, a közös tulajdonságaikkal együtt. Az alapvető API-k olyan kötegelt műveletek végrehajtásakor használhatók, amelyek nem kényszerítik az adott elemtípushoz tartozó tulajdonságok manipulálását.

  • Számítási feladatok API-k – A számítási feladatok API-k egy adott elemtípust céloznak meg a Fabricben.

Az alapvető és számítási feladatok referenciaoldali szakaszai betűrendben listáznak minden API-t. Minden szakasz tartalmaz egy áttekintést, amely tartalmazza a szakasz összes API-jának listáját, valamint a szakasz API-jainak betűrendes listáját.

Elemspecifikus bejegyzés

Az elemspecifikus szakasz részletezi a Fabric egyes elemtípusainak részleteit. Minden elemtípus-bejegyzés a következőket tartalmazza:

  • Áttekintés: Az elemtípus rövid leírása.

  • Végpontok: Felsorolja az elemtípushoz elérhető végpontokat, valamint a paraméterek, a kérelem- és válaszformátumok részleteit, valamint példákat.

  • Modellek: Meghatározza az elemtípus adatmodelljeit, megadva a tulajdonságokat és a típusokat.

  • Műveletek: Felsorolja az elemtípushoz elérhető műveleteket, beleértve a paraméterek részleteit, a kérelem- és válaszformátumokat, valamint példákat.

Az elemspecifikus bejegyzéssel megismerheti az API egy adott elemtípushoz kapcsolódó egyedi aspektusait, és útmutatást nyújt az adott elemtípushoz kapcsolódó műveletek végrehajtásához.

Referenciaoldal-struktúra

Minden referenciaoldal a következő szakaszokkal rendelkezik:

  • Áttekintés – Az API-t leíró cikk tetején található rövid bekezdés.

  • Engedélyek – Az API meghívásához szükséges felhasználói engedélyek listája.

  • Kötelező hatókör – Az API által igényelt engedélyek (más néven hatókörök) listája.

  • Korlátozások – (nem kötelező) Az API korlátozásainak listája.

  • Felület – Megjeleníti az API HTTP-formáját.

  • URI-paraméterek – Egy adott erőforrás vagy erőforrás azonosítására használt paraméterek listája.

  • Kérelem törzse – Az API-nak átadható tulajdonságok listája.

  • Válaszok – Az API lehetséges válaszainak listája.

  • Példák – Az API használatát bemutató példák listája.

  • Definíciók – Az API-nak átadható objektumok szerkezetét és tulajdonságait meghatározó paraméterek.

Az új API-dokumentáció referenciastruktúrája az API-információk elérésének és felhasználásának egyértelmű és konzisztens módját hivatott biztosítani. A CORE szakasz és az elemspecifikus bejegyzés elválasztásával reméljük, hogy a fejlesztők könnyebben megtalálják és felhasználhatják a Microsoft Fabric szolgáltatással való integrációhoz szükséges információkat.

Örömmel fogadjuk visszajelzéseit és javaslatait a dokumentáció és az API továbbfejlesztésére vonatkozóan.

Kapcsolódó tartalom

  • Last updated on