API di infrastruttura per la visualizzazione dello schema GraphQL ed Esplora schemi

Lo schema GraphQL, basato sul linguaggio SDL (GraphQL Schema Definition Language), definisce il formato dei dati esposti nell'API. Offre flessibilità ai consumer nascondendo i dettagli di implementazione back-end. Lo schema usa una raccolta di tipi di oggetto che contengono campi.

Visualizza schema

Accedere alla visualizzazione schema selezionando Schema nell'angolo inferiore sinistro della schermata Sviluppo dati. Questa visualizzazione mostra una versione basata su testo di GraphQL SDL con tipi, campi e operazioni generati.

L'immagine seguente mostra un esempio della visualizzazione schema, incluso un elenco di oggetti disponibili in questo schema.

Nota

La visualizzazione schema è di sola lettura. Modificare gli oggetti solo in Esplora schemi.

Esplora schema

Esplora schemi 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 vengono visualizzati nell'elenco Esplora schemi. I tipi appaiono sotto il nome dell'origine dati da cui sono stati ricavati. L'immagine seguente mostra il tipo SalesOrderDetail derivato dalla tabella SalesOrderDetail nell'endpoint di analisi SQL AdventureWorks .

Oltre ai tipi, l'API infrastruttura per GraphQL genera automaticamente query e mutazioni per 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.

Screenshot del riquadro 'Esplora schema' che mostra un elenco espanso delle query generate automaticamente.

Espandere il nodo delle mutazioni nell'albero di Esplora schemi per visualizzare le mutazioni generate automaticamente dall'API.

Modificare gli oggetti usando Esplora schemi

È 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. Questa modifica influisce solo sullo schema DELL'API e non influisce sull'oggetto origine dati originale da cui deriva.

• Rimuovi dallo schema : elimina l'oggetto dallo schema GraphQL, quindi non puoi più farvi riferimento.

• Gestisci relazioni : apre l'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 o disabilitazione per query e mutazioni fornisce agli amministratori e agli sviluppatori un controllo granulare sull'accesso e l'utilizzo delle 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 schemi hanno due altre opzioni:

• Disabilita: impedisce a qualsiasi richiesta di eseguire la query o la mutazione. Se viene tentata l'esecuzione, viene restituito un errore. Dopo aver disabilitato una query o una mutazione, si verifica un ricaricamento dello schema e la query o la mutazione viene visualizzata in grigio in Esplora schemi.

• Abilita: consente di riabilitare una query o una mutazione disabilitata in precedenza. La query o la mutazione è immediatamente disponibile dopo l'operazione di ricaricamento dello schema che si verifica quando si seleziona l'opzione Abilita .

Le query o le mutazioni generate automaticamente dalle stored procedure possono essere eliminate solo. Dopo l'eliminazione, possono essere letti usando le opzioni Recupera dati o Aggiorna schema .

Contenuto correlato

• Altre informazioni sull'api infrastruttura per l'editor GraphQL.