Importer une API GraphQL

  • Article

S’APPLIQUE À : tous les niveaux de Gestion des API

Dans Gestion des API, vous pouvez ajouter une API GraphQL selon l’un des deux modèles suivants : pass-through vers un point de terminaison GraphQL existant ou importation d’un schéma GraphQL et création d’une API GraphQL synthétique avec des résolveurs de champs personnalisés. Pour plus d’informations, consultez la Vue d’ensemble de GraphQL.

Dans cet article, vous allez :

  • Ajouter une API GraphQL pass-through dans votre instance Gestion des API.
  • Tester votre API GraphQL.

Si vous souhaitez importer un schéma GraphQL et configurer des résolveurs de champs à l’aide de points de terminaison REST ou SOAP API, consultez Importer un schéma GraphQL et configurer des résolveurs de champs.

Prérequis

Ajouter une API GraphQL

  1. Dans le portail Azure, accédez à votre instance APIM.

  2. Dans le menu de gauche, cliquez sur API> + Ajouter une API.

  3. Sous Définir une nouvelle API, sélectionnez l’icône GraphQL.

    Capture d’écran de la sélection de l’icône GraphQL dans la liste des API

  4. Dans la boîte de dialogue, sélectionnez Complète et renseignez les champs de formulaire requis.

    Capture d’écran des champs pour la création d’une API GraphQL

    Champ Description
    Nom complet Nom sous lequel votre API GraphQL est affichée.
    Nom Nom brut de l’API GraphQL. Se remplit automatiquement à mesure que vous tapez le nom complet.
    type de GraphQL Sélectionnez Pass-through GraphQL pour importer depuis un point de terminaison d’API GraphQL existant.
    Point de terminaison de l’API GraphQL URL de base avec le nom de point de terminaison de l’API GraphQL.
    Par exemple : https://example.com/your-GraphQL-name. Vous pouvez également utiliser un point de terminaison GraphQL « swapi » comme https://swapi-graphql.azure-api.net/graphql en démo.
    Charger un schéma Sélectionnez éventuellement parcourir et charger votre fichier de schéma pour remplacer le schéma récupéré à partir du point de terminaison GraphQL (le cas échéant).
    Description Ajoutez une description de votre API.
    Modèle d’URL Effectuez une sélection selon votre point de terminaison GraphQL. Sélectionnez l’une des options contenant un schéma WebSocket (WS ou WSS) si votre API GraphQL inclut le type d’abonnement. Sélection par défaut : HTTP(S).
    Suffixe de l’URL de l’API Ajoutez un suffixe d’URL pour identifier cette API spécifique dans cette instance de gestion des API. Il doit être unique dans cette instance Gestion des API.
    URL de base Champ non modifiable affichant l’URL de base de votre API
    Balises Associez votre API GraphQL à des étiquettes nouvelles ou existantes.
    Produits Associez votre API GraphQL à un produit pour la publier.
    Créer une version pour cette API ? Sélectionnez pour appliquer un schéma de versioning à votre API GraphQL.

  5. Sélectionnez Create (Créer).

  6. Une fois l’API créée, parcourez ou modifiez le schéma sous l’onglet Création. Capture d’écran de l’exploration du schéma GraphQL dans le portail.

Tester votre API GraphQL

  1. Accédez à votre instance API Management.

  2. Dans le menu de navigation latéral, sous la section API, sélectionnez API.

  3. Sous Toutes les API, sélectionnez votre API GraphQL.

  4. Sélectionnez l’onglet Test pour accéder à la console de test.

  5. Sous En-têtes :

    1. Sélectionnez l’en-tête dans le menu déroulant Nom.
    2. Entrez la valeur dans le champ Valeur.
    3. Ajoutez d’autres en-têtes en sélectionnant + Ajouter un en-tête.
    4. Supprimez les en-têtes à l’aide de l’icône de corbeille.

  6. Si vous avez ajouté un produit à votre API GraphQL, appliquez l’étendue du produit sous Appliquer l’étendue du produit.

  7. Sous Éditeur de requête, vous pouvez :

    1. Sélectionner au moins un champ ou sous-champ dans la liste du menu latéral. Les champs et les sous-champs que vous sélectionnez s’affichent dans l’éditeur de requête.

    2. Commencer à taper dans l’éditeur de requête pour composer une requête.

      Capture d’écran de l’ajout de champs dans l’éditeur de requêtes

  8. Sous Variables de requête, ajoutez des variables pour réutiliser la même requête ou mutation et passer des valeurs différentes.

  9. Sélectionnez Envoyer.

  10. Consultez la Réponse.

    Capture d’écran de l’affichage de la réponse de la requête de test

  11. Répétez les étapes précédentes pour tester différentes charges utiles.

  12. Une fois le test effectué, quittez la console de test.

Testez un abonnement

Si votre API GraphQL prend en charge un abonnement, vous pouvez tester ce dernier dans la console de test.

  1. Vérifiez que votre API autorise un schéma d’URL WebSocket (WS ou WSS) approprié pour votre API. Vous pouvez activer ce paramètre dans l’onglet Paramètres .

  2. Configurez une requête d’abonnement dans l’éditeur de requête, puis sélectionnez Connecter pour établir une connexion WebSocket au service back-end.

    Capture d’écran d’une requête d’abonnement dans l’éditeur de requête.

  3. Passez en revue les détails de la connexion dans le volet Abonnement.

    Capture d’écran d’une connexion Websocket dans le portail.

  4. Les événements abonnés s’affichent dans le volet Abonnement. La connexion WebSocket est conservée jusqu’à ce que vous la déconnectiez ou que vous vous connectiez à un nouvel abonnement WebSocket.

    Capture d’écran des événements d’un abonnement GraphQL dans le portail.

Sécuriser votre API GraphQL

Sécurisez l’API GraphQL en appliquant à la fois des stratégies d’authentification et d’autorisation existantes et une stratégie de validation GraphQL pour la protection contre les attaques ciblant GraphQL.

Étapes suivantes

Transform and protect your API (Transformer et protéger votre API)