Concevoir une API Rest avec PHP

Une API (Application Programming Interface) est un ensemble normalisé de classes, de méthodes ou de fonctions qui sert de façade par laquelle un logiciel offre des services à d’autres logiciels. Une API Rest renvoie les données d’une base de données sous format Json. Dans cet article, nous allons voir ensemble comment mettre en place une API Rest avec du PHP.

• Créons un projet et ouvrons le avec notre éditeur (dans mon cas j’utilise VS Code) :

• Créons un fichier api.php :

Maintenant que notre fichier est prêt à être édité, créons notre base de données.

• Création de la base de données

Allez sur la plateforme de phpMyAdmin et créez une nouvelle base de données (nommez-la comme vous voulez). Ensuite créez un table « etudiants » (id, prenom, nom). NB : Pour la création de la table « etudiants », vous pouvez importer le bout de code suivant :

CREATE TABLE `etudiants` (
  `id` int(11) NOT NULL,
  `prenom` varchar(255) NOT NULL,
  `nom` varchar(255) NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Vous pouvez maintenant ajouter des étudiants dans votre base de données. Revenons à présent sur notre fichier PHP et commençons à coder notre API.

<?php

header('Content-Type: application/json');

/**
 * connexion à la base de données
 */
try {
    $connexion = new PDO('mysql:host=localhost;dbname=db_api;charset=utf8','root','');
    $retour["success"] = true;
    $retour["message"] = "Connexion à la base de données réussie";
}
catch(Exception $ex) {
    $retour["success"] = false;
    $retour["message"] = "Erreur de connexion à la base de données";
}

$request = $connexion->prepare("SELECT * FROM etudiants");
$request->execute();

$resultat = $request->fetchAll();

$retour["message"] = "Voici les étudiants";
$retour["resultats"]["etudiants"] = $resultat;

echo json_encode($retour);

?>

Copiez le code ci-dessus et collez le dans votre fichier api.php. Ouvrez maintenant le projet sur votre navigateur et si tout se passe bien, vous verrez le contenu de votre base de données sous format Json :

Voila, nous venons de créer notre première API avec PHP. Mais notez bien que ce que nous venons de faire n’est pas sécurisé. Donc pour concevoir des API pour des projets sérieux, nous serons amenés à utiliser un framework comme Symfony qui nous permet de gérer plus facilement le coté sécurité.