Intouch - Services informatiques
Dprès avoir créé une API bien structurée avec toutes les fonctions et fonctionnalités incluses, vous pouvez arriver à un point où vous voulez tester la fonctionnalité de l'API afin de pouvoir la partager avec d'autres développeurs ou l'utiliser sur d'autres plates-formes comme une application Android. Cet article vous aidera à comprendre comment utiliser Postman pour tester la fonctionnalité de l'API afin que vous puissiez identifier s'il y a des problèmes avant de la déployer pour une utilisation dans des applications actives.
Qu'est-ce que Postman?
Postman est une application informatique utilisée comme outil pour tester les API. Postman collecte votre demande API et agit comme un intermédiaire pour que votre demande puisse être envoyée au serveur Web et renvoyée immédiatement pour afficher le résultat dans son interface. Postman est conçu de manière simple à utiliser avec une interface simple, car il ne nécessite aucun codage, il suffit de sélectionner la méthode que vous souhaitez utiliser, de saisir votre lien API et les paramètres s'ils existent, puis d'envoyer et d'attendre une réponse.
Postman est un logiciel open-source, ce qui signifie que vous pouvez le télécharger sans enregistrement de licence, ce qui le rend facile à utiliser pour n'importe quel développeur. Pour télécharger Postman, visitez le lien de téléchargement officiel de Postman qui est https://www.postman.com/downloads/ et suivez les instructions pour l'installer.
Une fois l'installation terminée, ouvrez Postman et vous trouverez une interface comme ci-dessous :
Utiliser Postman pour tester le fonctionnement de l'API
Dans notre article précédent, nous avons créé une API REST de connexion en utilisant PHP et MYSQL "Créer une API REST en PHP" qui ressemble à cela :
<?php
header("Content-Type:application/json");
$dsn = "mysql:host=localhost;dbname=databasename";
$username = "username";
$password = "password1";
$options = array(PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION);
try {
$con = new PDO($dsn, $username, $password, $options);
} catch(PDOException $e) {
echo "Connection failed: " . $e->getMessage();
exit;
}
$email = $_POST["email"];
$password = $_POST["password"];
$stmt = $con->prepare("SELECT * FROM clients WHERE Email=:email AND Password=:password");
$stmt->bindParam(':email', $email);
$stmt->bindParam(':password', $password);
$stmt->execute();
if($stmt->rowCount() > 0) {
$json = array("status" => 200,'message' => "Success");
} else {
$json = array("status" => 300,'message' => "Error");
}
echo json_encode($json);
$con = null;
?>
J'ai enregistré le fichier login.php ci-dessus dans mon dossier public_html à l'intérieur d'un dossier appelé APIs de cet espace de serveur. Donc, mon lien complet pour accéder au fichier de connexion sera http://localhost/htdocs/apis/login.php.
Pour obtenir les résultats, cela signifie que je devrai envoyer des données que je collecte sous forme d'e-mail et de mot de passe. Dans ce cas, ils sont appelés des paramètres envoyés sous forme de données de formulaire.
La méthode que nous utilisons est POST.
La représentation de celle-ci est la suivante ...
- Pour une réponse réussie :
- Pour une réponse avec des valeurs qui ne correspondent pas à celles de la base de données.
Vous remarquerez que, dans le programme Postman, chaque section est affichée de manière compréhensible, à savoir :
- La section de méthode se trouve en haut à gauche.
- La section d'URL suit la méthode.
- En dessous, vous trouverez la section de paramètres sous forme de données de formulaire.
- La section de réponse est laissée avec une zone plus large en bas.
Pour partager l'API avec un autre utilisateur, vous pouvez utiliser le format simple suivant que tout le monde comprendra.
LOGIN API // title of the API
URL http://localhost/htdocs/apis/login.php // URL to the API file
PARAMS email,password // values to post
RESPONSE // response value
{
"status": 200,
"message": "Success"
}
Conclusion
Avec cela, nous avons mis en évidence les étapes importantes pour utiliser Postman afin de tester la fonctionnalité d'une API.
L'extension de VS Code "Thunder Client" est une option pour tester les API REST. Avec Thunder Client, vous peuvez tester les API REST directement dans l'éditeur de code.
* Pay to Play
Comme dans le domaine de la musique, le pay to play (ou payola) est la pratique par laquelle un artiste ou son représentant (maison de disques, agent) paye la personne contrôlant l'accès à un moyen de diffusion (salle de spectacle, émission de radio) afin d'accéder à ce moyen, dans le domaine du webmarketing une entreprise ou son agence de e-marketing paye les grands acteurs du numérique (Google, Facebook …) afin d’accéder à un public cible par les moyens publicitaires sur ces plateformes.
