Comment soumettre une demande à REST Web API
Type de demande
Le test REST Web API prend en charge différentes méthodes HTTP qui peuvent être utilisées en fonction de vos objectifs de test. La sélection d’une demande GET permettra simplement de récupérer des données à partir de votre API Web. Bien que les paramètres de demande puissent être inclus dans l’URL, il est recommandé d’utiliser des méthodes dédiées pour pousser la charge utile vers une API.
Pour envoyer des informations personnalisées, modifier des données ou déclencher tout flux ou événement, utilisez des types de demandes tels que POST, PUT ou PATCH. Dans ce cas, pour spécifier l’organisme de demande, accédez à la section Données postales.
Si vous définissez le type de demande sur POST, PUT ou PATCH, mais que vous ne spécifiez pas les paramètres de demande dans la section Données postales, le type de demande sera modifié pour revenir à GET lors de l’enregistrement de la tâche.
authentification
Si votre API nécessite une authentification, fournissez les informations d’identification dans la section Authentification de base. Si l’authentification basée sur les jetons est la méthode utilisée, suivez les recommandations fournies pour les API basées sur OAuth 2.0 et configurez les paramètres d’authentification de la même manière.
Données postales
Dans cette section, vous pouvez facilement fournir toutes les entités de demande, telles que JSON.
Pour spécifier l’organisme de demande, il suffit de coller ou d’entrer le contenu JSON dans le champ. Le système sera automatiquement parse le code et vous serez invité à sélectionner un en-tête de type de contenu basé sur le type de corps de demande. En outre, vous pouvez fournir un en-tête personnalisé de type contenu si c’est nécessaire.
Une fois spécifié, le type de contenu sera automatiquement ajouté à la section En-têtes.
Création d’une collection de demandes
Vous pouvez soumettre autant de demandes dans un test que vous le souhaitez. Notez que toutes les demandes doivent être ajoutées au test dans l’ordre où elles doivent être exécutées.
Pour configurer un test multi-demandes :
- Tout d’abord, créez et enregistrez un nouveau test d’API Rest Web.
- Pour configurer une séquence de requêtes dans le test, dans la liste des tests, à partir du menu d’action du
test, sélectionnez Ajouter la cible. - Configurez les paramètres de demande et enregistrez les modifications. Les demandes seront répertoriées sur la barre latérale de l’écran de modification de l’appareil dans l’ordre où elles seront exécutées. Pour accéder aux paramètres de demande, sélectionnez l’élément correspondant sur la barre latérale.
- Pour ajouter la demande suivante à partir de l’interface de modification de l’appareil, cliquez sur le bouton «plus» sur la barre latérale.
Pour en savoir plus sur la configuration et la surveillance des périphériques multi-cibles, voir Ajout de plusieurs cibles au sein d’un seul appareil.
Validation des résultats
En général, il ne suffit pas de simplement passer un appel à une API, le but de s’assurer que la réponse api contient des données qui devaient recevoir. Pour vérifier la réponse api, il suffit de trouver quelques mots clés qui correspondent exactement dans la réponse. Connaissant le contenu de votre réponse API, vous pouvez fournir les mots clés de la section Validation de contenu. Pour plus de détails, consultez l’article Mot clé.
Use Cases
Prenons l’exemple d’une API REST par e-mail. Pour surveiller le service, nous devons envoyer la demande POST au point de terminaison correspondant de l’API, ainsi que les détails de l’e-mail dans l’organisme de demande. Pour ce faire, nous devons fournir l’URL du point de terminaison et sélectionner le type de demande POST.
Étant donné que l’API REST par e-mail nécessite une authentification de base, nous devons également fournir les informations d’identification dans la section correspondante.
Dans la section Données postales, nous spécifierons le tableau JSON avec les détails de l’e-mail et sélectionnerons le type d’en-tête pour pousser la charge utile vers le point final de l’API.
L’étape suivante consiste à spécifier un mot clé à rechercher dans la réponse API pour sa validation.
-
Surveillance de l’API REST
La majorité des applications Web modernes utilisent une API REST pour communiquer avec le serveur et s’intégrer les unes aux autres. En assurant une bonne qualité des données dans l’API, nous assurons la qualité de l’ensemble du service Web qui les utilise.
Supposons que vous avez créé une API RESTful pour votre service Web, et qu’il est nécessaire de contrôler que toutes les fonctions de l’API fonctionnent correctement et sont disponibles 24 heures sur 24, 7 jours sur 7. Mais pourquoi avons-nous besoin de tester une API WEB, n’est-il pas plus facile de tester une interface utilisateur pour les problèmes? Discutons des avantages les plus courants des tests et de la surveillance de l’API.
Le premier avantage des tests d’API REST est qu’il permet d’identifier une source particulière d’un problème. En testant votre API, vous pouvez trouver quelle fonction spécifique est exécutée avec des erreurs.
En outre, avec les tests API, vous n’avez pas besoin de créer un environnement de test dédié pour tester les fonctionnalités de votre service Web. Contrairement aux tests d’interface utilisateur qui nécessitent une chaîne d’actions utilisateur dans une fenêtre de navigateur pour envoyer une demande à un serveur Web, les tests et la surveillance de l’API peuvent être effectués à l’aide d’outils automatisés pour envoyer une demande de point de terminaison spécifique. Par exemple, cette approche vous permet de contourner un problème tel que de fausses défaillances de test se produisent au niveau de l’INTERFACE GRAPHIQUE.
Bien que vous puissiez tester toutes les fonctions de l’API manuellement, il s’agit d’un processus difficile et long. En outre, chaque fois que vous modifiez ou ajoutez de nouvelles fonctionnalités à votre API, les tests doivent être exécutés à nouveau pour s’assurer que les mises à jour n’ont pas affecté la fonctionnalité API. La surveillance automatisée de l’API REST permet d’éviter les inconvénients des tests manuels et peut faire passer votre routine de surveillance de l’API au niveau suivant.
Surveillance de l’API REST avec Dotcom-Monitor
Dotcom-Monitor offre deux options pour la surveillance automatisée des performances de l’API :
- Le dispositif de surveillance de l’API WEB REST.
- Le dispositif de surveillance de la collection Postman.
Pour configurer le test de surveillance de l’API RESTful à partir de zéro, il est recommandé d’utiliser notre dispositif de surveillance de l’API WEB REST. Ce type d’appareil de surveillance vous permet de configurer une simple demande HTTP vers un point de terminaison API avec une authentification de base et des paramètres POST.
Dans le cas où vous avez déjà utilisé Postman pour exécuter les tests de vos services d’API RESTful, il est recommandé d’importer votre collection Postman à Dotcom-Monitor. Une fois que la collecte des demandes de facteur a été importée dans le système, vous pouvez configurer le dispositif de surveillance de la collection postier pour automatiser la surveillance de vos services d’API.
Bien que l’appareil REST Web API prend en charge l’exécution multi-demandes, dans certains cas, il peut être difficile à configurer. À son tour, si vous êtes familier avec l’outil, Postman est idéal pour configurer les demandes HTTP paramétrisées et les tests d’affirmation pour la surveillance de l’API WEB REST.
Ainsi, si vous souhaitez créer un test avec une séquence compliquée d’appels API ou lorsqu’une authentification autre que l’authentification de base est requise, utilisez Postman pour créer une collection d’appels API. Ensuite, il suffit de l’importer sur le dispositif dotcom-monitor postman collection et mettre en place la surveillance comme décrit dans la surveillance facteur (tâches de collecte) avec Dotcom-Monitor API. Dotcom-Monitor exécutera les appels API avec une fréquence spécifiée (jusqu’à 1 min), générera des rapports et enverra des notifications d’erreur de surveillance à une adresse fournie.
N’oubliez pas de consulter notre gamme complète d’outils de surveillance api chez Dotcom-Monitor pour vous aider à assurer la fiabilité des applications et services Web!