Del via

Struktur af dokumentation til Fabric REST API

Microsoft Fabric REST API'er er udviklet til at hjælpe udviklere med at automatisere Fabric. Fabric REST API-referencesiderne (dokumentation) er struktureret for at hjælpe udviklere med at finde de oplysninger, de har brug for.

Referencesiderne er opdelt i to hovedafsnit:

  • Kerne-API'er – Kerne-API'er leverer oplysninger og funktionalitet til alle elementer i Microsoft Fabric. Kerne-API'er er ikke specifikke for én arbejdsbelastning og kan bruges på tværs af alle arbejdsbelastninger. Kerne-API'er er CRUD-API'er (Create, Read, Update og Delete). Du kan bruge dem til at oprette eller opdatere Fabric-elementer sammen med deres fælles egenskaber. Kerne-API'erne kan bruges under udførelse af batchhandlinger, der ikke gennemtvinger manipulation af nogen egenskab, der er specifik for en bestemt elementtype.

  • Arbejdsbelastnings-API'er – Arbejdsbelastnings-API'er er målrettet en bestemt elementtype i Fabric.

Afsnittene med hoved- og arbejdsbelastningsreferencesiden indeholder en alfabetisk liste over alle API'er. Hvert afsnit indeholder en oversigt, der indeholder en liste over alle API'er i sektionen og en alfabetisk liste over API'erne i sektionen.

Elementspecifik post

Det elementspecifikke afsnit indeholder detaljer om hver varetype i Fabric. Hver elementtypepost indeholder:

  • Oversigt: En kort beskrivelse af elementtypen.

  • Slutpunkter: Viser tilgængelige slutpunkter for elementtypen sammen med oplysninger om parametre, anmodnings- og svarformater og eksempler.

  • Modeller: Definerer datamodellen for elementtypen og angiver egenskaber og typer.

  • Handlinger: Viser en liste over tilgængelige handlinger for elementtypen, herunder oplysninger om parametre, anmodnings- og svarformater og eksempler.

Brug den elementspecifikke post til at forstå de entydige aspekter af API'en, der er relateret til en bestemt elementtype, og for at få hjælp til at udføre handlinger, der er relateret til den pågældende elementtype.

Referencesidestruktur

Hver referenceside har følgende afsnit:

  • Oversigt – Et kort afsnit øverst i artiklen, der beskriver API'en.

  • Permissions – En liste over brugertilladelser, der er nødvendige for at kalde API'en.

  • Obligatorisk område – En liste over tilladelser (også kaldet områder), som API'en kræver.

  • Begrænsninger – (valgfrit) En liste over begrænsninger for API'en.

  • Interface – Viser API'ens HTTP-formular.

  • URI-parametre – En liste over parametre, der bruges til at identificere en bestemt ressource eller ressourcer.

  • Brødtekst for anmodning – En liste over egenskaber, der kan overføres til API'en.

  • Svar – En liste over mulige svar fra API'en.

  • Eksempler – En liste over eksempler, der viser, hvordan du bruger API'en.

  • Definitioner – Parametre, der definerer strukturen og egenskaberne for et objekt, der kan overføres til API'en.

Den nye api-dokumentationsreferencestruktur er beregnet til at give en klar og ensartet måde at få adgang til og bruge API-oplysningerne på. Ved at adskille core-sektionen og elementets specifikke post håber vi at gøre det nemmere for udviklere at finde og bruge de oplysninger, de skal bruge til at integrere med Microsoft Fabric-tjenesten.

Vi glæder os over din feedback og forslag til, hvordan du kan forbedre dokumentationen og API'en.

Relateret indhold