Un’implementazione dell’IDE GraphiQL standard è disponibile con l’API GraphQL di Adobe Experience Manager (AEM).
GraphiQL è incluso in tutti gli ambienti di AEM (ma sarà accessibile/visibile solo quando configuri gli endpoint).
Nelle versioni precedenti, era necessario un pacchetto per installare l’IDE GraphiQL. Se installato, ora è possibile rimuoverlo.
Prima di utilizzare l’IDE GraphiQL, devi avere configurato gli endpoint nel browser delle configurazioni.
Lo strumento GraphiQL consente di testare ed eseguire il debug delle query GraphQL consentendoti di:
dev-publish
);Puoi accedere all’editor delle query da:
http://localhost:4502/aem/graphiql.html
Puoi utilizzare GraphiQL nel tuo sistema in modo che le query possano essere richieste dall’applicazione client mediante richieste GET, nonché per pubblicarle. Per l’utilizzo in produzione, puoi quindi spostare le query nell’ambiente di produzione. Inizialmente devi spostarle nell’istanza Author dell’ambiente di produzione per convalidare i contenuti appena creati con le query, e infine nell’istanza Publish di produzione per l’utilizzo live.
Come primo passo è necessario selezionare l’endpoint da utilizzare per le query. L’endpoint è appropriato per la configurazione Sites che desideri utilizzare per le query.
È disponibile dall’elenco a discesa in alto a destra.
Puoi inserire la nuova query nell’editor, che si trova nel pannello centrale a sinistra, direttamente sotto il logo GraphiQL.
Se hai già selezionato una query persistente, ed è visualizzata nel pannello editor, seleziona +
(accanto a query persistenti) per svuotare l’editor approntandolo per la nuova query.
A questo punto è sufficiente iniziare a digitare. L’editor, inoltre:
Le query GraphQL in genere iniziano con un carattere {
.
Le righe che iniziano con #
vengono ignorate.
Utilizza Salva con nome per rendere persistente la nuova query.
Seleziona la query da aggiornare dall’elenco nel pannello delle query persistenti (a sinistra).
La query viene visualizzata nel pannello dell’editor. Apporta le modifiche necessarie, quindi utilizza Salva per confermare gli aggiornamenti della query persistente.
Puoi eseguire immediatamente una nuova query oppure caricare ed eseguire una query persistente. Per caricare una query persistente, selezionala dall’elenco: la query viene visualizzata nel pannello dell’editor.
In entrambi i casi, la query visualizzata nel pannello dell’editor è quella che verrà eseguita quando:
Control-Enter
.L’IDE GraphiQL consente inoltre di gestire le variabili di query.
Esempio:
Dopo aver selezionato il query persistente dall’elenco (pannello a sinistra) puoi utilizzare Pubblica e Annulla pubblicazione azioni. Queste consentono di attivarle nell’ambiente di pubblicazione (ad esempio, dev-publish
) per renderle facilmente accessibili dalle applicazioni in fase di test.
La definizione della cache della query persistente Time To Live
{"cache-control":"parameter":value} ha un valore predefinito di 2 ore (7200 secondi).
L’opzione Copia URL consente di simulare una query copiando l’URL utilizzato per accedere direttamente alla query persistente e visualizzare i risultati. Questa può quindi essere utilizzata per i test; ad esempio, accedendo in un browser:
Esempio:
http://localhost:4502/graphql/execute.json/global/article-list-01
Utilizzando questo URL in un browser, puoi confermare i risultati:
L’opzione Copia URL è accessibile tramite i tre punti verticali a destra del nome della query persistente (pannello a sinistra):
L’opzione Elimina è anch’essa accessibile tramite i tre punti verticali a destra del nome della query persistente (pannello a sinistra).
Dopo aver sviluppato e testato la query persistente con GraphiQL, occorre trasferirla all’ambiente di produzione in modo che possa essere utilizzata dalle applicazioni.
Nell’IDE è disponibile una selezione di scelte rapide da tastiera per accedere direttamente alle icone di azione:
Shift-Control-P
Shift-Control-M
Control-Enter
Control-Space
Su alcune tastiere il tasto Control
è etichettato come Ctrl
.