Activation de l'éditeur GraphiQL pour une API GraphQL

Si vous sélectionnez l'option Activer l'éditeur GraphiQL lors de la création d'une API de proxy GraphQL , les utilisateurs peuvent tester l'API à l'aide d'un éditeur GraphiQL dans un navigateur Web ; API Connect répond à la demande initiale de l'éditeur GraphiQL avec une page HTML qui permet le test à partir de l'éditeur GraphiQL .

La désactivation de l'option Activer l'éditeur GraphiQL réduit le trafic et le temps d'attente de la passerelle et, en outre, le portail de développeur fournit une fonction de test équivalente, que vous activiez ou non l'option.

Cette option ajoute automatiquement le paramètre de propriété suivant à la source OpenAPI pour l'API de proxy GraphQL :

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

Si vous désactivez Activer l'éditeur GraphiQL lors de la création de l'API et que vous décidez ultérieurement que cette option est nécessaire, vous pouvez ajouter manuellement ce paramètre de propriété ou sélectionner Activer l'éditeur GraphiQL sur la page Configuration d'API de l'onglet Conception de l'API.

Remarque :

La propriété html-page doit être utilisée uniquement avec une API de proxy GraphQL.
store:///graphiql.html est la seule valeur autorisée pour la propriété html-page.
Si vous ajoutez la propriété html-page mais que la propriété Prendre en charge l'introspection standard n'a pas été activée lors de la création de l'API, la page HTML GraphiQL n'affiche aucune documentation concernant le serveur de back end GraphQL, effectue une validation de requête ou effectue une recherche intelligente. Pour plus de détails sur la création manuelle de la configuration de stratégie d'assemblage requise, voir Prise en charge de l'introspection pour une API GraphQL.