Condividi tramite

Struttura della documentazione dell'API REST di Fabric

Le API REST di Microsoft Fabric sono progettate per aiutare gli sviluppatori ad automatizzare Fabric. Le pagine di riferimento dell'API REST di Fabric (documentazione) sono strutturate per aiutare gli sviluppatori a trovare le informazioni necessarie.

Le pagine di riferimento sono suddivise in due sezioni principali:

  • API principali : le API principali forniscono informazioni e funzionalità per tutti gli elementi all'interno di Microsoft Fabric. Le API principali non sono specifiche di un carico di lavoro e possono essere usate in tutti i carichi di lavoro. Le API principali sono le API Create, Read, Update ed Delete (CRUD). È possibile usarli per creare o aggiornare gli elementi di Fabric insieme alle relative proprietà comuni. Le API principali possono essere usate durante l'esecuzione di operazioni batch che non forzano la manipolazione di alcuna proprietà specifica di un determinato tipo di elemento.

  • API del carico di lavoro : le API del carico di lavoro sono destinate a un tipo di elemento specifico in Fabric.

Le sezioni della pagina di riferimento core e del carico di lavoro elencano tutte le API in ordine alfabetico. Ogni sezione contiene una panoramica che include un elenco di tutte le API nella sezione e un elenco alfabetico delle API nella sezione.

Voce specifica dell'elemento

La sezione specifica dell'elemento descrive in dettaglio le specifiche di ogni tipo di elemento in Fabric. Ogni voce del tipo di elemento contiene:

  • Panoramica: breve descrizione del tipo di elemento.

  • Endpoint: elenca gli endpoint disponibili per il tipo di elemento, insieme ai dettagli sui parametri, sui formati di richiesta e risposta ed esempi.

  • Modelli: definisce il modello di dati per il tipo di elemento, specificando proprietà e tipi.

  • Azioni: elenca le azioni disponibili per il tipo di elemento, inclusi i dettagli sui parametri, i formati di richiesta e risposta ed esempi.

Usare la voce specifica dell'elemento per comprendere gli aspetti univoci dell'API correlati a un tipo di elemento specifico e per indicazioni sull'esecuzione di operazioni correlate a tale tipo di elemento.

Struttura della pagina di riferimento

Ogni pagina di riferimento include le sezioni seguenti:

  • Panoramica : paragrafo breve nella parte superiore dell'articolo che descrive l'API.

  • Autorizzazioni : elenco delle autorizzazioni utente necessarie per chiamare l'API.

  • Ambito obbligatorio : un elenco di autorizzazioni (note anche come ambiti) richieste dall'API.

  • Limitazioni : (facoltativo) Elenco di limitazioni per l'API.

  • Interfaccia : visualizza il formato HTTP dell'API.

  • Parametri URI : elenco di parametri usati per identificare una risorsa o una risorsa specifica.

  • Corpo della richiesta : elenco di proprietà che possono essere passate all'API.

  • Risposte : elenco di possibili risposte dall'API.

  • Esempi : elenco di esempi che illustrano come usare l'API.

  • Definizioni : parametri che definiscono la struttura e le proprietà di un oggetto che possono essere passati all'API.

La nuova struttura di riferimento della documentazione dell'API è progettata per fornire un modo chiaro e coerente di accedere e usare le informazioni sull'API. Separando la sezione CORE e la voce specifica dell'elemento, ci auguriamo che sia più semplice per gli sviluppatori trovare e usare le informazioni necessarie per l'integrazione con il servizio Microsoft Fabric.

Sono disponibili commenti e suggerimenti su come migliorare la documentazione e l'API.

Contenuti correlati