Bonjour à tous et bienvenue dans ce Tutoriel sur Flask. Dans la suite de cet article, vous allez apprendre à mettre en place une API sous Python à l’aide de cet outil de plus en plus utilisé.
Qu’est-ce qu’une API ? Quand est-ce utile ?
Nous allons commencer ce tutoriel sur Flask en parlant des APIs. Les API (application programming interface / interface de programmation d’application) sont des interfaces. Elles vous permettent de déclencher des fonctionnalités d’un projet. Vous pouvez vous imaginer un panneau de commandes. Et Flask est un outil qui permet de construire des API avec python.
Si vous disposez de code qui vous sert à réaliser des tâches, peu importe lesquelles, vous pourriez vouloir le rendre disponible, permettre à des utilisateurs d’envoyer des requêtes à votre service. Et c’est dans ce contexte que mettre en place une API vous intéressera.
Exemple :
Pour donner l’exemple d’une situation dans laquelle vous auriez besoin d’une API : imaginez que vous veniez de développer une fonctionnalité permettant, à partir d’une image, d’obtenir une valeur numérique.
On a la fonction “fonction1” qui prend en paramètre un objet de type bytes (une image) qui sera traité et qui fournira en sortie une variable de type string.
Dire que vous aimeriez mettre en place une interface pour qu’un utilisateur distant puisse lui envoyer une requête, que cet utilisateur puisse dire à votre programme “s’il te plait, exécute le code sur l’image que je te fournit et renvoie moi le résultat” c’est comme dire que vous aimeriez mettre en place une API.
Les types de requêtes
En travaillant sur la mise en place d’API, on a remarqué que les requêtes qu’on voulait implémenter se catégorisent très souvent parmi ces quatre :
- Créer un élément
- Modifier un élément
- Supprimer un élément
- Récupérer une liste d’éléments
Nous allons donc voir dans ce tutoriel sur flask comment implémenter des requêtes de type : get (récupérer), post (envoyer), put (modifier), delete (supprimer).
Il existe d’autres types de requêtes, vous n’en aurez surement pas besoin mais vous pourrez les trouver ici.
Adresse et routes
Vous allez run votre service sur une machine, que ce soit la vôtre ou celle que vous louez dans un datacenter.
Elle aura une adresse IP. Notez que l’adresse 127.0.0.1 signifie “moi-même”. Si vous envoyez une requête à cette adresse, c’est vers votre PC que vous vous dirigez.
Votre ordinateur ou le serveur sur lequel vous voulez faire fonctionner le service sont des machines et elles ont des “ports” sur lesquels les services peuvent communiquer.
Votre API, ce sera un programme qui sera en écoute sur un port de la machine sur laquelle il est installé.
Si vous lancez votre API sur le port 1234 de votre machine, vous pourrez lui envoyer des requêtes en précisant l’url 127.0.0.1:1234
Une dernière chose : mettons que j’ai deux fonctionnalités : fonction1 et fonction2 qui sont toutes deux des requêtes de type get. Comment mon utilisateur pourra m’indiquer celle qu’il veut utiliser en ne fournissant que l’adresse 127.0.0.1:1234 ?
On pourrait imaginer que pour déclencher la fonction1, il puisse s’adresser à 127.0.0.1:1234/ici et que pour déclencher la fonction2, il puisse s’adresser à 127.0.0.1:1234/la. Eh bien c’est comme ça que cela fonctionne et on appelle /ici et /la des “routes”.
Notez que “/”, est la route par défaut. Si vous envoyez une requête à 127.0.0.1:1234, on considèrera que vous vous adressez à 127.0.0.1:1234/
Prise en main de flask et implémentation de routes
La base
Le module Flask de python permet d’implémenter des API : pip install Flask.
Voici le snippet dont ces images sont extraites. Il est accessible via ce github repository.
Dans le répertoire où se situe le main.py, vous pouvez lancer la commande “python main.py”.
On aura alors un programme python en écoute sur le port 5000 (voir main.py ligne 14).
Il accepte des requêtes de type get à la route exemple_route (voir main.py ligne 11 et ligne 5 ainsi que routes/exemple_route.py ligne 4).
Les paramètres
Pour que les choses deviennent plus intéressantes, on accepte des paramètres. Voici le même snippet avec quelques lignes supplémentaires (exemple_route_/exemple_route.py : lignes 4; 5; 6; 10 et 11).
Tester son API
Pour tester vos routes, je vous propose dans ce tutoriel sur flask, d’utiliser postman ou la bibliothèque requests de Python :
Une API CRUD (Create Read Update Delete)
Vous pouvez consulter ce github repository qui permet de faire les quatre types de requêtes (get, post, put, delete) et qui présente deux routes : exemple_route et exemple_route_all.
Les requêtes acceptées sont :
- exemple_route get : prend “user” en paramètre et renvoie son mot de passe s’il existe
- exemple_route post : prend “user” et “password” en paramètres et ajoute une valeur à notre liste d’utilisateurs
- exemple_route put : prend “user” et “password” en paramètres et modifie le mot de passe de l’utilisateur user s’il existe
- exemple_route delete : prend “user” en paramètre et supprimer l’utilisateur s’il existe
- exemple_route_all get : ne prend pas de paramètre et renvoie la liste des utilisateurs et leur mot de passe
En inspectant le code, on se rend compte qu’il existe une variable “données” (exemple_route/exemple_route.py ligne 14). Elle sera récupérée dans les méthodes implémentées à la suite grâce à la ligne de commande “global données “.
Pour vous permettre de créer une API, je vous suggère :
- de disposer des bibliothèques : Flask, flask_cors, flask_restful
- de partir d’un clone du repository Small_flask_api
- d’y ajouter des fichiers dans le dossier routes pour contenir vos classes et la définition de leurs paramètres en vous inspirant du repository Exemple_API_1
- d’ajouter les imports de classes dans le main.py et de déclarer leur associations
Je vous fournis un programme disponible sur ce repository. La fonction approximation_lagrange du fichier utils.py prend une liste de points en paramètres et renvoie une liste de coefficients d’un polynôme d’interpolation. La fonction écrire_polynome du fichier operations.py prend cette valeur dernièrement retournée pour rendre la syntaxe de l’écriture du polynôme interprétable par un éditeur LaTeX.
Je vous propose d’implémenter une API qui permette d’opérer sur une liste de points : récupérer, ajouter, supprimer. Elle permet également de récupérer l’expression d’un polynôme passant par les points de contrôle.
Vous trouverez une solution ici.
La documentation Flask
Pour continuer d’apprendre et acquérir des compétences après ce tutoriel sur flask, il vous faudra expérimenter au travers de projets, personnels et/ou professionnels. Vous aurez surement besoin de consulter la documentation flask et les forums d’entraide en cas de besoin, notamment Stack Overflow.
Envoyer un fichier ou une image
Envoyer une image en réponse est fréquemment demandé, ainsi je vous explique comment faire.
Importer send_file de la bibliothèque flask et l’appeler au retour d’une route en spécifiant le chemin pour situer le fichier. Vous pouvez consulter ce repository illustrant le renvoie d’images.
Se former sur Flask
Datascientest propose la formation au métier de data engineer qui permet non seulement d’apprendre à construire des API avec Flask, mais aussi d’utiliser FastApi et de, par la suite, conteneuriser les services API. La conteneurisation est un procédé utilisé pour isoler ses services, simplifier leur scalabilité et leur déploiement cross-platform.
