Abilitazione dell'editor GraphiQL per una API GraphQL

Se si seleziona Abilita editor GraphiQL quando si crea un'API proxy GraphQL , gli utenti possono verificare l'API utilizzando un editor GraphiQL in un browser Web; API Connect risponde alla richiesta iniziale dell'editor GraphiQL con una pagina HTML che abilita il test dall'editor GraphiQL .

La disattivazione dell'opzione Enable GraphiQL editor riduce il traffico e la latenza del gateway e, inoltre, il portale CMS offre una capacità di test equivalente indipendentemente dall'attivazione o meno dell'opzione.

Questa opzione aggiunge automaticamente la seguente impostazione della propriet ... all'origine OpenAPI per l'API proxy GraphQL :

html-page: 'store:///graphiql.html'

Se si disabilita l'editor Abilita GraphiQL durante la creazione dell'API e successivamente si decide che è richiesto, è possibile aggiungere manualmente questa impostazione di proprietà oppure selezionare Abilita editor GraphiQL nella pagina Configurazione API della scheda Progettazione dell'API.

Nota:

la proprietà html-page deve essere utilizzata solo con un'API proxy GraphQL .
store:///graphiql.html è l'unico valore consentito per la proprietà html-page .
Se si aggiunge la proprietà html-page ma la proprietà Supporta introspezione standard non è stata abilitata durante la creazione dell'API, la pagina HTML GraphiQL non mostrerà alcuna documentazione relativa al server di backend GraphQL , eseguire la convalida della query o eseguire la ricerca intelligente. Per i dettagli su come creare manualmente la configurazione della politica di assemblaggio richiesta, consultare Supporting introspection for a GraphQL API.