Visualizzazione schema ed Esplora schema dell’API Fabric per GraphQL
Nota
L’API Microsoft Fabric per GraphQL è in anteprima.
Lo schema GraphQL, basato su SDL (Schema Definition Language), definisce il formato dei dati esposti nell'API. È un livello di astrazione che offre flessibilità ai consumer nascondendo i dettagli di implementazione back-end. Lo schema si basa su una raccolta di tipi di oggetto che contengono campi.
Visualizza schema
È possibile accedere alla visualizzazione schema selezionando Schema nell'angolo inferiore sinistro della schermata Sviluppo dati. La visualizzazione mostra una versione basata su testo di GraphQL SDL con tipi, campi e operazioni generati.
L'immagine seguente è un esempio di visualizzazione schema, incluso un elenco completo di oggetti disponibili in questo schema.
Nota
La visualizzazione schema è di sola lettura. È possibile modificare oggetti solo in Esplora schema.
Esplora schema
Esplora schema si trova nel riquadro a sinistra ed è disponibile anche quando si usa l'editor nella visualizzazione query. Esplora consente agli utenti di visualizzare rapidamente i tipi e i campi disponibili, nonché le query e le mutazioni, definiti nell'API.
Tutti i tipi GraphQL disponibili dagli oggetti scelti quando ci si connette a un'origine dati appaiono nell'elenco Esplora schema. I tipi appaiono sotto il nome dell'origine dati da cui sono stati ricavati. Nell'immagine seguente si vede il tipoSalesOrderDetail ricavato dalla tabella SalesOrderDetail nell'endpoint AdventureWorks di Analisi SQL.
Oltre ai tipi, l'API Fabric per GraphQL genera automaticamente query e mutazioni per tutti i nuovi oggetti che si sceglie di esporre.
Nell'esempio AdventureWorks, espandendo l'elenco delle query vengono mostrate le query generate automaticamente per l'origine dati.
Per visualizzare le mutazioni generate automaticamente dall'API, espandere il nodo delle mutazioni nell'albero di Esplora schema.
Modificare gli oggetti usando Esplora schema
È possibile usare Esplora schema per modificare gli oggetti dopo che l'API li ha creati automaticamente. Nell'esempio seguente vengono selezionati i puntini di sospensione accanto al tipo SalesOrderDetail ricavato dal database AdventureWorks:
Per Tipi sono disponibili le opzioni seguenti:
- Aggiorna schema: consente di aggiornare lo schema con nuovi oggetti dall'origine dati.
- Rinomina: modifica il nome dell'oggetto. NOTA: questa modifica influisce solo sullo schema dell'API e non ha alcun effetto sull'oggetto origine dati originale da cui è stato ricavato.
- Rimuovi dallo schema: elimina in modo efficace l'oggetto dallo schema GraphQL in modo da non potervi più fare riferimento.
- Gestisci relazioni: conduce all'esperienza di gestione delle relazioni. Per altre informazioni, vedere Gestire le relazioni nell'API Fabric per GraphQL.
- Proprietà: mostra informazioni aggiuntive sull'oggetto.
Abilitare e disabilitare query e mutazioni
La funzionalità di abilitazione/disabilitazione per query e mutazioni fornisce agli amministratori e agli sviluppatori un controllo granulare sull'accesso e l'utilizzo dell’API. Consente di attivare o disattivare in modo selettivo query e mutazioni specifiche all'interno dello schema GraphQL. In questo modo è possibile gestire in modo dinamico le funzionalità dell’API senza modificare il codice o distribuire le modifiche.
Le query e le mutazioni in Esplora schema includono due opzioni aggiuntive:
- Disabilita: impedisce a qualsiasi richiesta di eseguire la query o la mutazione. Se viene tentata l'esecuzione, viene restituito un errore. Una volta disabilitata una query o una mutazione, si verifica un ricaricamento dello schema e la query o la mutazione viene appare in grigio in Esplora schema.
- Abilita: riabilitare una query o una mutazione disabilitata in precedenza. L'esecuzione dell'elemento è immediatamente disponibile dopo l'operazione di ricaricamento dello schema eseguita che avviene dopo la selezione dell'opzione Abilita.
Si noti che le query o le mutazioni generate automaticamente da stored procedure possono essere solo eliminate. Dopo l'eliminazione, possono essere aggiunte nuovamente usando le opzioni Recupera dati o Aggiorna schema.