En tant que développeur d'API, vous connaissez probablement Postman, un outil populaire pour tester et automatiser les requêtes API. Postman Newman est un outil de référence pour de nombreux développeurs depuis des années, mais il n'est pas sans limites.
Dans ce guide, nous allons couvrir l'installation et l'utilisation de Newman, un outil en ligne de commande conçu pour exécuter des collections Postman. En suivant ce guide, vous apprendrez comment installer Newman et exécuter des collections Postman, ce qui vous permettra d'automatiser votre processus de test d'API. A recommande Apidog comme une alternative puissante.
Qu'est-ce que Newman dans Postman ?
Newman Postman est un outil en ligne de commande qui permet aux développeurs d'exécuter des collections et des environnements Postman dans un environnement d'intégration continue (CI). Postman est un outil de développement d'API populaire qui permet aux développeurs de concevoir, de tester et de documenter les API. Newman, quant à lui, est un outil qui permet aux développeurs d'automatiser les tests d'API à l'aide de collections et d'environnements Postman.
Avec Newman Postman, les développeurs peuvent facilement automatiser les tests d'API et s'assurer que leurs API fonctionnent comme prévu. Newman prend en charge une gamme d'intégrations et de plugins, ce qui en fait un outil polyvalent pour le développement d'API. Cependant, il existe certaines limites à Newman Postman dont les développeurs doivent être conscients, telles que sa complexité de configuration et d'exécution des tests lents et le coût pour une utilisation à grande échelle.
Quelle est la différence entre Newman et Postman ?
Postman et Newman sont tous deux des outils de développement d'API, mais ils servent des objectifs différents. Postman est une application de bureau qui permet aux développeurs de tester les API avec une interface utilisateur graphique (GUI). Newman, quant à lui, est un outil en ligne de commande qui permet aux développeurs d'exécuter des collections et des environnements Postman dans un environnement d'intégration continue (CI), ce qui facilite l'automatisation des tests d'API.
Une autre différence entre Postman et Newman est leur coût. Postman propose une version gratuite, mais propose également des plans payants avec des fonctionnalités supplémentaires. Newman, quant à lui, est un outil open-source qui est gratuit.
Comment exécuter une collection Postman dans Newman ?
Installation de Newman
Newman est basé sur Node.js. Pour exécuter Newman, assurez-vous que Node.js est installé. Et Node.js >= v16. Vous pouvez installer Node.js avec le gestionnaire de paquets :
L'utilisation de NPM est un moyen courant et facile d'installer Newman. Entrez la commande suivante dans le terminal.
npm install -g newman
En utilisant l'indicateur "-g", Newman sera installé globalement sur votre système, ce qui vous permettra de l'exécuter depuis n'importe quel endroit.
Exécution des collections Postman avec Newman
Vous pouvez utiliser la commande "newman run" pour indiquer quelle collection exécuter. Il est simple d'exporter votre collection Postman en tant que fichier JSON depuis Postman, puis de l'exécuter à l'aide de Newman.
newman run mycollection.json
Recommandé de lire :

Conseils bonus de Postman Newman
Utilisation de Newman avec CI/CD
Newman se termine avec un code d'état de 0 par défaut si tout se déroule sans problème et sans exception. Pour vous assurer que vos outils d'intégration continue (CI) répondent aux codes de sortie de Newman et réussissent ou échouent une build en conséquence, vous pouvez les configurer en conséquence.
De plus, vous pouvez utiliser l'indicateur "--bail" pour que Newman arrête l'exécution s'il rencontre une erreur de cas de test avec un code d'état de 1. Cette erreur peut ensuite être récupérée par votre outil CI ou votre système de build et traitée en conséquence.
Utilisation de Newman en tant que bibliothèque Node.js
Newman peut également être utilisé comme une bibliothèque Node.js, ce qui permet aux développeurs d'intégrer les tests d'API dans leurs applications Node.js. En utilisant Newman comme une bibliothèque, les développeurs peuvent exécuter des collections par programmation, accéder aux résultats des tests et intégrer les tests dans leur processus de build.
const newman = require('newman'); // Import Newman module
async function runCollection() {
try {
await newman.run({
collection: require('./sample-collection.json'),
reporters: 'cli'
});
console.log('Collection run complete!');
} catch (err) {
console.error(err);
}
}
runCollection();
Cet exemple de code utilise la syntaxe async/await pour rendre l'exécution de Newman plus concise et lisible. Il importe le module Newman et définit une fonction asynchrone nommée runCollection pour exécuter la collection. Dans la fonction, il utilise le mot-clé await pour attendre que Newman ait fini de s'exécuter, puis affiche un message indiquant que la collection a été exécutée. Si une erreur se produit, il la capture et l'affiche. Enfin, il appelle la fonction runCollection() pour exécuter l'ensemble du programme.
Alternative à Postman Newman : Apidog
Apidog prend en charge l'exportation de scénarios de test vers les formats Apidog CLI, Postman et JMeter, ce qui facilite l'intégration des tests d'API dans votre processus d'intégration continue.
L'Apidog CLI est conçu spécifiquement pour exécuter des scénarios de test Apidog dans la ligne de commande, offrant un moyen simplifié d'exécuter des tests et d'automatiser le processus de test. En exportant des scénarios de test vers Apidog CLI, les développeurs peuvent facilement intégrer les tests d'API dans leurs processus de build et s'assurer que les API sont testées de manière approfondie et cohérente.
En plus d'Apidog CLI, Apidog prend également en charge l'exportation de scénarios de test vers les formats Postman et JMeter, offrant aux développeurs une plus grande flexibilité dans leur approche des tests. Avec ces options d'exportation, les développeurs peuvent choisir l'outil de test qui correspond le mieux à leurs besoins et intégrer les tests d'API de manière transparente dans leur flux de travail de développement.
Comment installer Apidog CLI
Prérequis : Tout d'abord, vous devez installer Node.js. De préférence, version >=v16.
Utilisez la commande ci-dessous pour installer :
npm install -g apidog-cli
Vous pouvez installer Apidog CLI globalement via npm sur votre système, ce qui vous permet de l'exécuter depuis n'importe quel endroit.
npm install -g apidog-cli
Voici plusieurs commandes que vous pouvez utiliser pour confirmer si Apidog CLI a été installé avec succès.
node -v && apidog -v && which node && which npm && which apidog
Si l'installation a réussi, l'exécution des commandes ci-dessus affichera immédiatement le numéro de version et le chemin d'installation.

Exécution avec des données en temps réel
Allez dans les "tests", ouvrez votre API souhaitée et passez à la page CI/CD. Si vous n'avez pas encore de scénario de test, créez-en un.


Configurez l'environnement, les données de test, les boucles, les intervalles, etc. Dans votre fournisseur CI/CD, choisissez "Ligne de commande" puis passez à "Exécuter les données exportées". Ici, vous pouvez choisir d'utiliser les données exportées par Newman.

Exécution des scénarios de test exportés
apidog run examples/sample.apidog-cli.json -r cli,html,json
Le rapport de test sera enregistré dans le répertoire apidog-reports.
Si vous souhaitez personnaliser le rapport, vous pouvez utiliser le résultat dans un fichier JSON pour personnaliser le rapport selon vos besoins.

Vous pouvez également localiser le répertoire /apidog-reports/ dans le dossier où vous avez exécuté le CLI. Ce répertoire contient le rapport de test CLI au format HTML
Conclusion
En suivant les étapes décrites dans ce guide, vous devriez maintenant avoir une bonne compréhension de la façon d'installer et d'exécuter Newman pour exécuter des collections Postman. Newman fournit une interface de ligne de commande qui permet des tests d'API automatisés, ce qui en fait un outil précieux pour les développeurs travaillant dans un environnement d'intégration continue.
Cependant, si vous recherchez une alternative à Newman qui offre une solution CI/CD plus robuste, je vous recommande vivement d'envisager Apidog. En plus de son interface conviviale pour les tests et la documentation des API, Apidog fournit également de puissantes fonctionnalités CI/CD. Avec des fonctionnalités telles que l'exportation de cas de test, les outils de collaboration, la génération automatique de documentation d'API et l'intégration transparente avec les pipelines CI/CD, Apidog fournit une solution complète pour les besoins de développement et de test d'API.
Que vous choisissiez de continuer à utiliser Newman ou d'explorer Apidog comme alternative, les deux outils peuvent grandement améliorer votre processus de test d'API. Cependant, si vous recherchez une solution plus complète avec de solides fonctionnalités CI/CD, Apidog vaut vraiment la peine d'être envisagé.