Del via

Dokumentasjonsstruktur for REST-API for stoff

Microsoft Fabric REST API-er er utformet for å hjelpe utviklere med å automatisere Fabric. Referansesidene for Fabric REST API (dokumentasjon) er strukturert for å hjelpe utviklere med å finne informasjonen de trenger.

Referansesidene er delt inn i to hoveddeler:

  • Kjerne-API-er – Kjerne-API-er gir informasjon og funksjonalitet for alle elementer i Microsoft Fabric. Kjerne-API-er er ikke spesifikke for én arbeidsbelastning, og kan brukes på tvers av alle arbeidsbelastninger. Kjerne-API-er er Opprett, Les, Oppdater og Slett (CRUD)-API-er. Du kan bruke dem til å opprette eller oppdatere stoffelementer sammen med de vanlige egenskapene. Kjerne-API-ene kan brukes under kjøring av satsvise operasjoner som ikke tvinger manipulering av noen egenskap som er spesifikk for en bestemt elementtype.

  • Arbeidsbelastnings-API-er – Arbeidsbelastnings-API-er er rettet mot en bestemt elementtype i Fabric.

Inndelingene kjerne- og arbeidsbelastningsreferansesiden viser alle API-er alfabetisk. Hver inndeling inneholder en oversikt som inneholder en liste over alle API-ene i inndelingen, og en alfabetisk liste over API-er i inndelingen.

Elementspesifikk oppføring

Den elementspesifikke delen beskriver detaljene for hver elementtype i Fabric. Hver elementtypeoppføring inneholder:

  • Oversikt: En kort beskrivelse av elementtypen.

  • Endepunkter: Viser tilgjengelige endepunkter for elementtypen, sammen med detaljer om parametere, forespørsels- og svarformater og eksempler.

  • Modeller: Definerer datamodellen for elementtypen, og angir egenskaper og typer.

  • Handlinger: Viser tilgjengelige handlinger for elementtypen, inkludert detaljer om parametere, forespørsels- og svarformater og eksempler.

Bruk den elementspesifikke oppføringen til å forstå de unike aspektene ved API-en som er relatert til en bestemt elementtype, og for veiledning om hvordan du utfører operasjoner relatert til denne elementtypen.

Referansesidestruktur

Hver referanseside har følgende inndelinger:

  • Oversikt – Et kort avsnitt øverst i artikkelen som beskriver API-en.

  • Tillatelser – en liste over brukertillatelser som kreves for å kalle API-en.

  • Obligatorisk omfang – en liste over tillatelser (også kjent som omfang) API-en krever.

  • Begrensninger – (valgfritt) En liste over begrensninger for API-en.

  • Grensesnitt – viser HTTP-skjemaet for API-en.

  • URI-parametere – en liste over parametere som brukes til å identifisere en bestemt ressurs eller ressurser.

  • Forespørselstekst – en liste over egenskaper som kan sendes til API-en.

  • Svar – en liste over mulige svar fra API-en.

  • Eksempler – en liste over eksempler som viser hvordan du bruker API-en.

  • Definisjoner – parametere som definerer strukturen og egenskapene til et objekt som kan sendes til API-en.

Den nye referansestrukturen for API-dokumentasjon er ment å gi en klar og konsekvent måte å få tilgang til og bruke API-informasjonen på. Ved å skille CORE-delen og den elementspesifikke oppføringen håper vi å gjøre det enklere for utviklere å finne og bruke informasjonen de trenger for å integrere med Microsoft Fabric-tjenesten.

Vi tar gjerne imot tilbakemeldinger og forslag til hvordan du kan forbedre dokumentasjonen og API-en.

Relatert innhold

  • Last updated on