Sinon TIG + exclusion du workshop.
Fedora / RHEL
sudo dnf install nodejs npmUbuntu / Debian
sudo apt install nodejs npmArch
sudo pacman -Sy nodejs npm-
Telechargez Postman version Linux (x64) sur le site officiel.
-
Depuis le dossier Downloads, bougez l'archive vers un dossier global comme opt :
sudo mv postman-linux-x64.tar.gz /opt/ && cd /opt/- Decompressez l'archive :
sudo tar xzvf postman-linux-x64.tar.gz- Supprimez l'archive :
sudo rm postman-linux-x64.tar.gz- Faites un symlink :
sudo ln -s /opt/Postman/Postman /usr/local/bin/postman- Créez le fichier pour avoir l'application bureau Postman:
touch ~/.local/share/applications/postman.desktopEditez le fichier avec ces informations :
[Desktop Entry]
Name=Postman
GenericName=API Client
X-GNOME-FullName=Postman API Client
Comment=Make and view REST API calls and responses
Keywords=api;
Exec=/usr/local/bin/postman
Terminal=false
Type=Application
Icon=/opt/Postman/app/resources/app/assets/icon.png
Categories=Development;Utilities;
Lancer le projet avec npm pour verifier que tout démarre :
npm i && npm run devVous aurez surement une erreur avec un code 'ERR_SOCKET_BAD_PORT', c'est normal.
Vous pouvez aller voir à quoi est directement relié npm run dev dans le fichier package.json mais pas besoin d'y toucher pour l'instant.
Quand vous commencez votre API, on vous demande quel port vous souhaitez utiliser, par défaut pour express on utilise le port 3030.
Nous utilisons un fichier .env qui sera lu par notre API pour lui donner, à vous de le remplir avec le bon.
Pour faire une requête il existe plusieurs moyens :
- Navigateur internet : ouvrez une page sur
http://localhost:3030(Ça ne marchera que pour un type de requête, attention) - curl :
curl -X GET localhost:3030 - Postman : se réferer à la documentation de Postman
Cet exercice a pour but de créer une première route de type GET, sur l'endpoint /, qui va tout simplement renvoyer Hello World !.
Maintenant que vous savez faire une requête, on va faire une nouvelle route :
Cette route de type GET, aura l'endpoint /hello.
Sa spécificité est de prendre un query parameter name.
La route devra renvoyer Hello + le paramètre donné à name.
Nous allons maintenant utiliser un nouveau type de requête : POST.
Cette requêtes devra prendre un body de type raw JSON
Ce JSON aura comme format :
{
"a" : 1,
"b" : 3
}Le but de la requête est de récupérer les deux nombres, les additionner et d'envoyer la somme.
Son endpoint sera /sum
Dans ce cas, elle enverra 4.
Faites la même chose pour les 3 autres operations de base avec ces endpoints :
/sub, /div, /mul
Faites une route qui écoute les requêtes de type GET.
Son endpoint sera /rand
Elle prend deux query parameters :
min et max
Elle devra renvoyer un nombre aléatoire entre min (inclu) et max (inclu).
Exemple avec ?min=4&max=10
On aura en retour :
6
Nous avons maintenant envie d'afficher les propriétés de toutes les requêtes qui passent sur notre API, pour se faire, Express propose des petits modules appelés middlewares qui vont avoir un seul rôle en particulier, et agir en fonction.
Pour cet exercice nous voulons un middleware de type "logger" qui va être utilisé avant de passer dans toutes les routes et qui va scanner chaques requêtes.
Nous souhaitons que ce logger affiche, respectivement :
L'heure de la requête, la méthode de la requête, et le nom de la route qui a été visée par la requête.
N'oubliez pas que le middleware doit passer avant la route en question, donc si je fais une requête GET à 13h54 sur /, je dois voir :
13:54:21 GET /
PUIS
Hello World !
Et non pas l'inverse.
Maintenant nous allons faire un nouvel endpoint de type GET /randog
Il a pour but de renvoyer l'adresse de l'image d'un chien aléatoire.
La banque de donnée de chien est située dans le fichier breed_list.json
À vous de voir comment importer le fichier et de le lire, puis de renvoyer une image aléatoire de chien.
On s'attend à ce que vous alliez sur
http://localhost:3030/randog avec votre navigateur et qu'une image de chien s'affiche (à vous de gérer l'affichage de l'image sur le navigateur)
Si vous êtes arrivés jusque là, bravo, vous n'avez touché qu'à une infime partie d'une API.
Libre à vous de faire ce que vous voulez, comme par exemple ajouter les informations du chien depuis la banque de données, ajouter une route qui prends la race du chien en query parameter et renvoie les différentes informations de celui ci.