Partager via


Tutoriel : Simuler des réponses de l’API

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

Les API principales sont importées dans une API Gestion des API Azure ou créées et gérées manuellement. Les étapes décrites dans ce tutoriel décrivent comment :

  • Utilisez Gestion des API pour créer une API HTTP vide.
  • Gérez manuellement une API HTTP.
  • Définissez une stratégie sur une API afin qu’elle retourne une réponse fictive.

Cette méthode permet aux développeurs de poursuivre l’implémentation et le test de l’instance Gestion des API, même si le back-end n’est pas disponible pour envoyer des réponses réelles.

Conseil

Les équipes d’API peuvent utiliser cette fonctionnalité dans des espaces de travail. Les espaces de travail fournissent un accès d’administration isolé aux API et à leurs propres environnements d’exécution d’API.

La possibilité de créer des réponses fictifs est utile dans de nombreux scénarios :

  • Lorsque la façade de l’API est conçue en premier et que l’implémentation du back-end se produit ultérieurement, ou lorsque le serveur principal est développé en parallèle.
  • Lorsque le back-end est temporairement non opérationnel ou n’est pas en mesure de s'adapter à la charge.

Dans ce tutoriel, vous allez apprendre à :

  • Créer une API de test
  • Ajouter une opération à l’API de test
  • Activer la simulation de réponse
  • Tester l’API simulée

Capture d’écran montrant la page API dans le portail Azure.

Prérequis

Créer une API de test

Cette section montre comment créer une API HTTP sans back-end.

  1. Connectez-vous au portail Azure et accédez à votre instance de Gestion des API.

  2. Sélectionnez la vignette API>+ Ajouter une API>HTTP :

    Capture d’écran montrant les premières étapes de définition d’une API.

  3. Dans la fenêtre Créer une API HTTP, sélectionnez Complète.

  4. Dans le nom d’affichage, entrez l’API test.

  5. Dans Produits, sélectionnez Illimité, si cette valeur est disponible. Cette valeur est disponible uniquement dans certains niveaux. Vous pouvez laisser la valeur vide pour ce didacticiel, mais vous devez associer l’API à un produit pour le publier. Pour plus d’informations, consultez Importer et publier votre première API.

  6. Dans les passerelles, sélectionnez Managed si cette option est disponible. (Cette option est avaiable uniquement dans certains niveaux de service.)

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

    Capture d’écran montrant la fenêtre Créer une API HTTP.

Ajouter une opération à l’API de test

Une API expose une ou plusieurs opérations. Dans cette section, vous ajoutez une opération à l’API HTTP que vous avez créée. Appeler cette opération après avoir terminé les étapes de cette section déclenche une erreur. Une fois que vous avez effectué les étapes de la section Activer la simulation de réponse , vous ne recevez pas d’erreur.

  1. Sélectionnez l’API que vous avez créée à l’étape précédente.

  2. Sélectionnez + Ajouter une opération.

  3. Dans la fenêtre frontend , entrez les valeurs suivantes :

    Paramètre Valeur Description
    Nom complet Appel de test Nom affiché dans le portail des développeurs.
    URL (première zone) GET Sélectionnez un des verbes HTTP prédéfinis.
    URL (deuxième boîte) /test Chemin d’URL de l’API.
    Description Description facultative de l’opération. Il fournit de la documentation dans le portail des développeurs aux développeurs qui utilisent l’API.

    Capture d’écran montrant la fenêtre frontend.

  4. Sélectionnez l’onglet Réponses , qui se trouve sous l’URL, le nom d’affichage et les zones Description . Vous entrez des valeurs sous cet onglet pour définir des codes d’état de réponse, des types de contenu, des exemples et des schémas.

  5. Sélectionnez + Ajouter une réponse, puis sélectionnez 200 OK dans la liste.

    Capture d’écran montrant l’onglet Réponses.

  6. Dans la section Représentations , sélectionnez + Ajouter une représentation.

  7. Entrez application/json dans la zone de recherche, puis sélectionnez le type de contenu application/json .

  8. Dans la zone Exemple , entrez { "sampleField" : "test" }.

  9. Sélectionnez Enregistrer.

    Capture d’écran montrant la section Représentations.

Bien qu’il ne soit pas nécessaire pour cet exemple, vous pouvez configurer d’autres paramètres pour une opération d’API sous d’autres onglets, comme décrit dans le tableau suivant :

Onglet Description
Requête Ajoutez des paramètres de requête. Outre un nom et une description, vous pouvez fournir des valeurs à affecter à un paramètre de requête. Vous pouvez marquer l’une de ces valeurs comme valeur par défaut (facultatif).
Requête Définissez des types de contenu de demande, des exemples et des schémas.

Activer la simulation de réponse

  1. Sélectionnez l’API que vous avez créée dans Créer une API de test.

  2. Vérifiez que l’onglet Création est sélectionné.

  3. Sélectionnez l’opération de test que vous avez ajoutée.

  4. Dans la section Traitement entrant, sélectionnez + Ajouter une stratégie.

    Capture d’écran montrant les premières étapes d’activation de la simulation de réponse.

  5. Sélectionnez la vignette Réponses fictifs dans la galerie :

    Capture d’écran montrant la vignette Simuler des réponses.

  6. Vérifiez que 200 OK, application/json s’affiche dans la zone de réponse Gestion des API . Cette sélection indique que votre API doit retourner l’exemple de réponse que vous avez défini dans la section précédente.

    Capture d’écran montrant la sélection de la réponse Gestion des API.

  7. Sélectionnez Enregistrer.

    Conseil

    Une barre jaune affichant le texte La simulation est activée s’affiche. Ce message indique que les réponses retournées par Gestion des API sont simulées par la stratégie de simulation et ne sont pas produites par le serveur principal.

Tester l’API simulée

  1. Sélectionnez l’API que vous avez créée dans Créer une API de test.

  2. Sous l’onglet Test , vérifiez que l’API d’appel de test est sélectionnée, puis sélectionnez Envoyer pour effectuer un appel de test :

    Capture d’écran montrant les étapes de test de l’API simulée.

  3. La réponse HTTP affiche le JSON fourni en tant qu’exemple dans la première section du didacticiel :

    Capture d’écran montrant la réponse HTTP fictif.

Étape suivante

Accédez au tutoriel suivant :

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