{"id":140363,"date":"2022-02-15T17:30:33","date_gmt":"2022-02-15T16:30:33","guid":{"rendered":"https:\/\/datascientest.com\/?p=140363"},"modified":"2024-09-26T13:07:28","modified_gmt":"2024-09-26T13:07:28","slug":"programmation-dapi-web-sous-python-avec-flask","status":"publish","type":"post","link":"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask","title":{"rendered":"Programmation d\u2019API Web sous Python avec Flask"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-post\" data-elementor-id=\"140363\" class=\"elementor elementor-140363\" data-elementor-post-type=\"post\">\n\t\t\t\t\t\t\t<div class=\"elementor-element elementor-element-b8da447 e-flex e-con-boxed e-con\" data-id=\"b8da447\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-6f87d12 elementor-widget elementor-widget-heading\" data-id=\"6f87d12\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.15.0 - 02-08-2023 *\/\n.elementor-heading-title{padding:0;margin:0;line-height:1}.elementor-widget-heading .elementor-heading-title[class*=elementor-size-]>a{color:inherit;font-size:inherit;line-height:inherit}.elementor-widget-heading .elementor-heading-title.elementor-size-small{font-size:15px}.elementor-widget-heading .elementor-heading-title.elementor-size-medium{font-size:19px}.elementor-widget-heading .elementor-heading-title.elementor-size-large{font-size:29px}.elementor-widget-heading .elementor-heading-title.elementor-size-xl{font-size:39px}.elementor-widget-heading .elementor-heading-title.elementor-size-xxl{font-size:59px}<\/style><h2 class=\"elementor-heading-title elementor-size-default\">L\u2019article va traiter de la programmation d\u2019API (Application Programming Interfaces) Web sous Python. Celles-ci sont des outils permettant de rendre accessibles de l\u2019information et des fonctionnalit\u00e9s via internet. Vous pouvez \u00e9galement d\u00e9couvrir comment <a href=\"https:\/\/datascientest.com\/connecter-une-api-a-une-base-de-donnees-sous-python\"><span style=\"color:#6e4bec\">connecter une API \u00e0 une base de donn\u00e9es sous python<\/span><\/a> et comment <a href=\"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion\"><span style=\"color:#6e4bec\">programmer et documenter une API avec python, flask, swagger et connexion.\n<\/span><\/a> Dans cet article, on verra :<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-4f13e1b elementor-widget elementor-widget-text-editor\" data-id=\"4f13e1b\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.15.0 - 02-08-2023 *\/\n.elementor-widget-text-editor.elementor-drop-cap-view-stacked .elementor-drop-cap{background-color:#69727d;color:#fff}.elementor-widget-text-editor.elementor-drop-cap-view-framed .elementor-drop-cap{color:#69727d;border:3px solid;background-color:transparent}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap{margin-top:8px}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap-letter{width:1em;height:1em}.elementor-widget-text-editor .elementor-drop-cap{float:left;text-align:center;line-height:1;font-size:50px}.elementor-widget-text-editor .elementor-drop-cap-letter{display:inline-block}<\/style>\t\t\t\t<ol><li><span style=\"color: #000000;\"><a style=\"color: #000000;\" href=\"#API1\">Qu\u2019est-ce qu\u2019une API ?<\/a><\/span><\/li><li><span style=\"color: #000000;\"><a style=\"color: #000000;\" href=\"#API2\">Quand utiliser une API ?<\/a><\/span><\/li><li><span style=\"color: #000000;\"><a style=\"color: #000000;\" href=\"#API3\">La terminologie associ\u00e9e aux API<\/a><\/span><\/li><li><span style=\"color: #000000;\"><a style=\"color: #000000;\" href=\"#API4\">Un premier exemple<\/a><\/span><\/li><li><span style=\"color: #000000;\"><a style=\"color: #000000;\" href=\"#API5\">Quelques principes de bonne conception des API Web<\/a><\/span><\/li><li><span style=\"color: #000000;\"><a style=\"color: #000000;\" href=\"#API6\">Exemples et documentation<\/a><\/span><\/li><li><span style=\"color: #000000;\"><a style=\"color: #000000;\" href=\"#API7\">R\u00e9f\u00e9rences bibliographiques<\/a><\/span><\/li><\/ol>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-ad433ce e-flex e-con-boxed e-con\" data-id=\"ad433ce\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-fc95872 elementor-widget elementor-widget-menu-anchor\" data-id=\"fc95872\" data-element_type=\"widget\" data-widget_type=\"menu-anchor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.15.0 - 02-08-2023 *\/\nbody.elementor-page .elementor-widget-menu-anchor{margin-bottom:0}<\/style>\t\t<div id=\"API1\" class=\"elementor-menu-anchor\"><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-1efb62f elementor-widget elementor-widget-heading\" data-id=\"1efb62f\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">1. Qu'est-ce qu'une API ?<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-56b8df5 elementor-widget elementor-widget-text-editor\" data-id=\"56b8df5\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Une API Web permet \u00e0 de l\u2019information et \u00e0 des fonctionnalit\u00e9s d\u2019\u00eatre manipul\u00e9es par des programmes informatiques via internet.<\/p><p>Par exemple, avec l\u2019API Web Twitter, on peut \u00e9crire un programme dans un langage comme Python ou Javascript qui collecte des m\u00e9tadonn\u00e9es sur les tweets.<\/p><blockquote><p><em>Plus g\u00e9n\u00e9ralement, en programmation, le terme API (abr\u00e9viation d&rsquo;Application Programming Interface) r\u00e9f\u00e8re \u00e0 une partie d\u2019un programme informatique con\u00e7ue pour \u00eatre utilis\u00e9e ou manipul\u00e9e par un autre programme, contrairement aux interfaces qui sont con\u00e7ues pour \u00eatre utilis\u00e9es ou manipul\u00e9es par des humains.<\/em><\/p><\/blockquote><p>Les programmes informatiques ont souvent besoin de communiquer entre eux ou avec le syst\u00e8me d\u2019exploitation sous-jacent et les API sont une fa\u00e7on de le faire.<\/p><p>Dans la suite, toutefois, on se limitera aux API Web.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-2d72b74 e-flex e-con-boxed e-con\" data-id=\"2d72b74\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-79050d6 elementor-widget elementor-widget-menu-anchor\" data-id=\"79050d6\" data-element_type=\"widget\" data-widget_type=\"menu-anchor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div id=\"API2\" class=\"elementor-menu-anchor\"><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-a367aa9 elementor-widget elementor-widget-heading\" data-id=\"a367aa9\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">2. Quand utiliser une API ?<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-1637515 elementor-widget elementor-widget-text-editor\" data-id=\"1637515\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Si on dispose de donn\u00e9es qu\u2019on souhaite partager avec le monde entier, cr\u00e9er une API Web est une fa\u00e7on de le faire.<\/p><p>Toutefois, les API ne sont pas toujours la meilleure mani\u00e8re de partager des donn\u00e9es avec des utilisateurs.<\/p><p>Si le volume des donn\u00e9es qu\u2019on souhaite partager est relativement faible, il vaut mieux proposer un \u00ab data dump \u00bb sous la forme d\u2019un fichier <strong>JSON, XML, CSV ou Sqlite<\/strong>. Selon les ressources dont on dispose, cette approche peut \u00eatre viable jusqu\u2019\u00e0 un volume de quelques Gigaoctets.<\/p><p>En g\u00e9n\u00e9ral, on utilise une API Web quand :<\/p><ul><li>Notre <strong>jeu de donn\u00e9es est important<\/strong>, ce qui rend le t\u00e9l\u00e9chargement par FTP lourd ou consommateur de ressources importantes.<\/li><li>Les utilisateurs ont besoin d\u2019<strong>acc\u00e9der aux donn\u00e9es en temps r\u00e9el<\/strong>, par exemple pour une visualisation sur un site web ou comme une partie d\u2019une application.<\/li><li>Nos donn\u00e9es sont modifi\u00e9es ou mises \u00e0 jour fr\u00e9quemment.<\/li><li>Les utilisateurs n\u2019ont besoin d\u2019acc\u00e9der qu\u2019\u00e0 <strong>une partie des donn\u00e9es \u00e0 la fois<\/strong>.<\/li><li>Les utilisateurs ont \u00e0 effectuer d\u2019autres actions que simplement consulter les donn\u00e9es, par exemple <strong>contribuer<\/strong>, <strong>mettre \u00e0 jour ou supprimer<\/strong>.<\/li><\/ul><p>Notons qu\u2019on peut fournir \u00e0 la fois un data dump et une API ; \u00e0 charge des utilisateurs de choisir ce qui leur convient le mieux.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-c47b359 e-flex e-con-boxed e-con\" data-id=\"c47b359\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-7213124 elementor-widget elementor-widget-menu-anchor\" data-id=\"7213124\" data-element_type=\"widget\" data-widget_type=\"menu-anchor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div id=\"un\" class=\"elementor-menu-anchor\"><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-eb5e94c elementor-widget elementor-widget-heading\" data-id=\"eb5e94c\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">3. La terminologie associ\u00e9e aux API<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-77e04dd elementor-widget elementor-widget-text-editor\" data-id=\"77e04dd\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p><strong>HTTP (HyperText Transfert Protocol)<\/strong> : c\u2019est le principal moyen de communiquer de l\u2019information sur Internet. HTTP impl\u00e9mente un certain nombre de \u00ab m\u00e9thodes \u00bb qui disent dans quelle direction les donn\u00e9es doivent se d\u00e9placer et ce qui doit en \u00eatre fait. Les deux plus fr\u00e9quentes sont GET, qui r\u00e9cup\u00e8re les donn\u00e9es \u00e0 partir d\u2019un serveur, et POST, qui envoie de nouvelles donn\u00e9es vers un serveur.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-81da997 elementor-widget elementor-widget-image\" data-id=\"81da997\" data-element_type=\"widget\" data-widget_type=\"image.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.15.0 - 02-08-2023 *\/\n.elementor-widget-image{text-align:center}.elementor-widget-image a{display:inline-block}.elementor-widget-image a img[src$=\".svg\"]{width:48px}.elementor-widget-image img{vertical-align:middle;display:inline-block}<\/style>\t\t\t\t\t\t\t\t\t\t\t\t<img decoding=\"async\" src=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/02\/illu_schema_http_1-85.png\" title=\"\" alt=\"\" loading=\"lazy\" \/>\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-51e064c elementor-widget elementor-widget-text-editor\" data-id=\"51e064c\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p><strong>URL (Uniform Ressource Locator)<\/strong> : Adresse d\u2019une ressource sur le web, comme <strong>http:\/\/www-facultesciences.univ-ubs.fr\/fr<\/strong>. Une URL consiste en un protocole (<strong>http:\/\/<\/strong>), un domaine (<strong>www-facultesciences.univ-ubs.fr<\/strong>), un chemin optionnel (<strong>\/fr<\/strong>).\u00a0<\/p><p>Elle d\u00e9crit l\u2019emplacement d\u2019une ressource sp\u00e9cifique, comme une page Web. Dans le domaine des API, les termes URL, request, URI, endpoint d\u00e9signent des id\u00e9es similaires. Dans la suite, on utilisera uniquement les termes URL et request (requ\u00eate), pour \u00eatre plus clair.\u00a0<\/p><p>Pour effectuer une requ\u00eate GET ou suivre un lien, il suffit de disposer d\u2019un navigateur Web.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-86d94ec elementor-widget elementor-widget-image\" data-id=\"86d94ec\" data-element_type=\"widget\" data-widget_type=\"image.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<img decoding=\"async\" src=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/02\/illu_schema_http_2-86.png\" title=\"\" alt=\"\" loading=\"lazy\" \/>\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-a7c7229 elementor-widget elementor-widget-text-editor\" data-id=\"a7c7229\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p><strong>JSON (JavaScript Object Notation)<\/strong>\u00a0: c\u2019est un format texte de stockage des donn\u00e9es con\u00e7u pour \u00eatre lisible \u00e0 la fois par les \u00eatres humains et les machines.\u00a0<strong>JSON est le format le plus usuel des donn\u00e9es r\u00e9cup\u00e9r\u00e9es par API<\/strong>, le deuxi\u00e8me plus usuel \u00e9tant XML.<\/p><p><strong>REST (REpresentational State Transfer)<\/strong>\u00a0: c\u2019est une m\u00e9thodologie qui regroupe les meilleures pratiques en termes de conception et d\u2019impl\u00e9mentation d\u2019APIs. Les API con\u00e7ues selon les principes de la m\u00e9thodologie REST sont appel\u00e9es des\u00a0<strong>API REST\u00a0(REST APIs)<\/strong>. Il y a toutefois de nombreuses pol\u00e9miques autour de la signification exacte du terme. Dans la suite, on parlera plus simplement d\u2019API Web ou d\u2019API HTTP.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-a7a192e e-flex e-con-boxed e-con\" data-id=\"a7a192e\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-c0214d9 elementor-widget elementor-widget-menu-anchor\" data-id=\"c0214d9\" data-element_type=\"widget\" data-widget_type=\"menu-anchor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div id=\"API4\" class=\"elementor-menu-anchor\"><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-c7866b1 elementor-widget elementor-widget-heading\" data-id=\"c7866b1\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">4. Un premier exemple<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-6ae47e8 elementor-widget elementor-widget-text-editor\" data-id=\"6ae47e8\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Dans la suite, on va voir comment cr\u00e9er une API en utilisant Python et le cadre de travail Flask.<\/p><p>Notre exemple d\u2019API portera sur un annuaire des employ\u00e9s d\u2019une entreprise qui fournira leur nom, pr\u00e9nom, fonction et anciennet\u00e9.<\/p><p>On commencera par utiliser <a href=\"http:\/\/flask.pocoo.org\">Flask<\/a>\u00a0pour cr\u00e9er une page web pour notre site. Cela nous permettra de voir comment Flask fonctionne. Une fois qu\u2019on aura une petite application Flask fonctionnelle sous la forme d\u2019une page Web, on transformera le site en une API.<\/p><p>Pourquoi Flask ? En effet, <a href=\"https:\/\/datascientest.com\/formation-langage-python\">Python<\/a> dispose de plusieurs cadres de d\u00e9veloppement (frameworks) permettant de produire des pages Web et des API.<\/p><p>Le plus connu est Django, qui est tr\u00e8s riche mais qui peut toutefois \u00eatre \u00e9crasant pour les utilisateurs non exp\u00e9riment\u00e9s.<\/p><p>Les applications Flask sont construites \u00e0 partir de canevas tr\u00e8s simples et sont donc plus adapt\u00e9es au prototypage d\u2019APIs.<\/p><p>On commence par cr\u00e9er un nouveau r\u00e9pertoire sur l\u2019ordinateur, qui servira de r\u00e9pertoire de projet et qu\u2019on nommera <strong>projects<\/strong>.<\/p><p>Les fichiers de notre projet seront stock\u00e9s dans un sous-<strong>r\u00e9pertoire de projects<\/strong>, nomm\u00e9 <strong>api<\/strong>.<\/p><p>On lance ensuite Spyder 3 ou tout autre EDI et on saisit le code suivant :<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-3e9b072 elementor-widget elementor-widget-shortcode\" data-id=\"3e9b072\" data-element_type=\"widget\" data-widget_type=\"shortcode.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div class=\"elementor-shortcode\"><script src=\"https:\/\/gist.github.com\/ssime-git\/47e012db9c69a8fd2b7661b84031e76e.js\"><\/script>\n\n<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-b3dd6a8 elementor-widget elementor-widget-text-editor\" data-id=\"b3dd6a8\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>On sauvegarde ensuite le programme sous le nom api.py dans le r\u00e9pertoire api pr\u00e9c\u00e9demment cr\u00e9\u00e9.<\/p><p>Afin de l\u2019ex\u00e9cuter, on lance une fen\u00eatre ligne de commande \u00e0 partir de ce r\u00e9pertoire et on saisit les commandes suivantes :<\/p><p style=\"padding-left: 40px;\"><strong>$ export FLASK_APP = api.py<\/strong><\/p><p style=\"padding-left: 40px;\"><strong>$ export FLASK_ENV = development<\/strong><\/p><p style=\"padding-left: 40px;\"><strong>$ flask run<\/strong><\/p><p>Alternativement, on peut ex\u00e9cuter le programme sous Spyder ou tout autre EDI utilis\u00e9.<\/p><p>On obtient dans le console l\u2019affichage suivant (entre autres sorties) :<\/p><p style=\"padding-left: 40px;\"><strong>* Running on http:\/\/127.0.0.1:5000\/ (Press CTRL+C to quit)<\/strong><\/p><p>Il suffit de saisir le lien pr\u00e9c\u00e9dent dans un navigateur Web pour acc\u00e9der \u00e0 l\u2019application.<\/p><p>On a ainsi cr\u00e9\u00e9 une application Web fonctionnelle.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-0eff739 elementor-widget elementor-widget-image\" data-id=\"0eff739\" data-element_type=\"widget\" data-widget_type=\"image.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<img decoding=\"async\" src=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/02\/API-1.png\" title=\"\" alt=\"\" loading=\"lazy\" \/>\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-ddc22bd elementor-widget elementor-widget-text-editor\" data-id=\"ddc22bd\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Examinons \u00e0 pr\u00e9sent la fa\u00e7on dont Flask fonctionne.<\/p><p>Flask envoie des requ\u00eates HTTP \u00e0 des fonctions Python. Dans notre cas, nous avons appliqu\u00e9 un chemin d\u2019URL (\u2018\/\u2018) sur une fonction : <strong>home<\/strong>.<\/p><p>Flask ex\u00e9cute le code de la fonction et affiche le r\u00e9sultat dans le navigateur. Dans notre exemple, le r\u00e9sultat est un code HTML de bienvenue sur le site h\u00e9bergeant notre API.<\/p><p>Le processus consistant \u00e0 appliquer des URL sur des fonctions est appel\u00e9 routage (routing).<\/p><p>L\u2019instruction :<\/p><p style=\"padding-left: 40px;\"><strong>@app.route(&lsquo;\/&rsquo;, methods=[\u2018GET&rsquo;])<\/strong><\/p><p>apparaissant dans le programme indique \u00e0 Flask que la <strong>fonction home<\/strong> correspond au chemin \/.<\/p><p>La liste methods<strong> (methods=[&lsquo;GET&rsquo;])<\/strong> est un argument mot-clef qui indique \u00e0 Flask le type de requ\u00eates HTTP autoris\u00e9es.<\/p><p>On utilisera uniquement des requ\u00eates GET dans la suite, mais de nombreuses applications Web utilisent \u00e0 la fois des requ\u00eates GET (pour envoyer des donn\u00e9es de l\u2019application aux utilisateurs) et POST (pour recevoir les donn\u00e9es des utilisateurs).<\/p><p>Commentons \u00e0 pr\u00e9sent le programme plus en d\u00e9tail.<\/p><p style=\"padding-left: 40px;\"><strong>import Flask<\/strong> : Cette instruction permet d\u2019importer la biblioth\u00e8que Flask, qui est disponible par d\u00e9faut sous Anaconda.<\/p><p style=\"padding-left: 40px;\"><strong>app = flask.Flask(__name__)<\/strong> : Cr\u00e9e l\u2019objet application Flask, qui contient les donn\u00e9es de l\u2019application et les m\u00e9thodes correspondant aux actions susceptibles d\u2019\u00eatre effectu\u00e9es sur l\u2019objet. La derni\u00e8re instruction app.run( ) est un exemple d\u2019utilisation de m\u00e9thode.<\/p><p style=\"padding-left: 40px;\"><strong>app.config[\u201cDEBUG\u201d = True]<\/strong> : lance le d\u00e9bogueur, ce qui permet d\u2019afficher un message autre que \u00ab Bad Gateway \u00bb s\u2019il y a une erreur dans l\u2019application.<\/p><p style=\"padding-left: 40px;\"><strong>app.run( )<\/strong> : permet d\u2019ex\u00e9cuter l\u2019application.<\/p><p>\u00c0 pr\u00e9sent, afin de cr\u00e9er l\u2019API, on va sp\u00e9cifier nos donn\u00e9es sous la forme d\u2019une liste de dictionnaires Python.<\/p><p>\u00c0 titre d\u2019exemple, on va fournir des donn\u00e9es sur trois employ\u00e9s de notre entreprise. Chaque dictionnaire contiendra un num\u00e9ro d\u2019identification, le nom, le pr\u00e9nom, la fonction et l\u2019anciennet\u00e9 d\u2019un employ\u00e9.<\/p><p>On introduira \u00e9galement une nouvelle fonction : une route permettant aux visiteurs d\u2019acc\u00e9der \u00e0 nos donn\u00e9es.<\/p><p>Ainsi, nous rempla\u00e7ons le code sauvegard\u00e9 dans <strong>api.py<\/strong> par le code suivant :<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-5e2c4c7 elementor-widget elementor-widget-shortcode\" data-id=\"5e2c4c7\" data-element_type=\"widget\" data-widget_type=\"shortcode.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div class=\"elementor-shortcode\"><script src=\"https:\/\/gist.github.com\/ssime-git\/2e26c382274e7c897e4364064490748f.js\"><\/script>\n<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-7551aa4 elementor-widget elementor-widget-text-editor\" data-id=\"7551aa4\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\tOn ex\u00e9cute le code sous Spyder 3 et on met \u00e0 jour la fen\u00eatre du navigateur, ce qui donne :\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-ae6d8f7 elementor-widget elementor-widget-image\" data-id=\"ae6d8f7\" data-element_type=\"widget\" data-widget_type=\"image.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<img decoding=\"async\" src=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/02\/Annuaire.png\" title=\"\" alt=\"Annuaire internet\" loading=\"lazy\" \/>\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-40f9071 elementor-widget elementor-widget-text-editor\" data-id=\"40f9071\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Pour acc\u00e9der \u00e0 l\u2019ensemble des donn\u00e9es, il suffit de saisir dans le navigateur l\u2019adresse :<\/p><p style=\"padding-left: 40px;\"><a href=\"http:\/\/127.0.0.1:5000\/api\/v1\/resources\/employees\/all\">http:\/\/127.0.0.1:5000\/api\/v1\/resources\/employees\/all<\/a><\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-ec24344 elementor-widget elementor-widget-image\" data-id=\"ec24344\" data-element_type=\"widget\" data-widget_type=\"image.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<img decoding=\"async\" src=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/02\/unnamed.png\" title=\"\" alt=\"\" loading=\"lazy\" \/>\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-3ec4236 elementor-widget elementor-widget-text-editor\" data-id=\"3ec4236\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>On a utilis\u00e9 la fonction <strong>jsonify<\/strong> de Flask. Celle-ci permet de convertir les listes et les dictionnaires au format JSON.<\/p><p>Via la route qu\u2019on a cr\u00e9\u00e9, nos donn\u00e9es sur les employ\u00e9s sont converties d\u2019une liste de dictionnaires vers le format JSON, avant d\u2019\u00eatre fournies \u00e0 l\u2019utilisateur.<\/p><p>\u00c0 ce stade, nous avons cr\u00e9\u00e9 une <strong>API fonctionnelle<\/strong>, bien que limit\u00e9e.<\/p><p>En effet, en l\u2019\u00e9tat actuel de notre API, les utilisateurs ne peuvent acc\u00e9der qu\u2019\u00e0 l\u2019int\u00e9gralit\u00e9 de nos donn\u00e9es; il ne peuvent sp\u00e9cifier de filtre pour trouver des ressources sp\u00e9cifiques.<\/p><p>Bien que cela ne pose pas probl\u00e8me sur nos donn\u00e9es de test, peu nombreuses, cela devient probl\u00e9matique au fur et \u00e0 mesure qu\u2019on ajoute des donn\u00e9es.<\/p><p>Dans la suite, on va introduire une fonction permettant aux utilisateurs de <strong>filtrer les r\u00e9sultats<\/strong> renvoy\u00e9s \u00e0 l\u2019aide de requ\u00eates plus sp\u00e9cifiques.<\/p><p>Le nouveau code est le suivant :<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-08a0433 elementor-widget elementor-widget-shortcode\" data-id=\"08a0433\" data-element_type=\"widget\" data-widget_type=\"shortcode.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div class=\"elementor-shortcode\"><script src=\"https:\/\/gist.github.com\/ssime-git\/e610427e1ef3e4d16e3ddce56688996c.js\"><\/script>\n<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-e7fc1a1 elementor-widget elementor-widget-text-editor\" data-id=\"e7fc1a1\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Apr\u00e8s avoir saisi, sauvegard\u00e9 et ex\u00e9cut\u00e9 le code sous Spyder 3, on peut saisir les adresses suivantes dans le navigateur :<\/p><p style=\"padding-left: 40px;\"><strong>127.0.0.1:5000\/api\/v1\/resources\/employees?id=0<\/strong><\/p><p style=\"padding-left: 40px;\"><strong>127.0.0.1:5000\/api\/v1\/resources\/employees?id=1<\/strong><\/p><p style=\"padding-left: 40px;\"><strong>127.0.0.1:5000\/api\/v1\/resources\/employees?id=2<\/strong><\/p><p style=\"padding-left: 40px;\"><strong>127.0.0.1:5000\/api\/v1\/resources\/employees?id=3<\/strong><\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-5c22113 elementor-widget elementor-widget-image\" data-id=\"5c22113\" data-element_type=\"widget\" data-widget_type=\"image.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<img decoding=\"async\" src=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/02\/API-3.png\" title=\"\" alt=\"\" loading=\"lazy\" \/>\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-91c01f9 elementor-widget elementor-widget-text-editor\" data-id=\"91c01f9\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Chacune de ces adresses renvoie un r\u00e9sultat diff\u00e9rent, except\u00e9 la derni\u00e8re, qui renvoie une liste vide, puisqu\u2019il n\u2019y a pas d\u2019employ\u00e9 d\u2019identifiant 3.<\/p><p>Dans la suite, on va examiner notre nouvelle API en d\u00e9tail.<\/p><blockquote><p><em>Nous avons cr\u00e9\u00e9 une nouvelle fonction api_root, avec l\u2019instruction @app_route, appliqu\u00e9e sur le chemin \/api\/v1\/resources\/employees.\u00a0<\/em><\/p><\/blockquote><p>Ainsi, la fonction est ex\u00e9cut\u00e9e d\u00e8s lors qu\u2019on acc\u00e8de \u00e0 <a href=\"http:\/\/127.0.0.1:5000\/api\/v1\/resources\/employees\">http:\/\/127.0.0.1:5000\/api\/v1\/resources\/employees<\/a>.<\/p><p>Notons qu\u2019acc\u00e9der au lien sans sp\u00e9cifier d\u2019ID, renvoie le message d\u2019erreur sp\u00e9cifi\u00e9 dans le code : Erreur: Pas d\u2019identifiant fourni. Veuillez sp\u00e9cifier un id.<\/p><p>Dans notre fonction, on fait deux choses : on commence par examiner l\u2019URL fournie \u00e0 la recherche d\u2019un identifiant, puis on s\u00e9lectionne le livre qui correspond \u00e0 l\u2019identifiant.<\/p><p>L\u2019ID doit \u00eatre fourni avec la syntaxe <strong>?id=0<\/strong>, par exemple.<\/p><p>Les donn\u00e9es pass\u00e9es \u00e0 l\u2019URL de cette fa\u00e7on sont appel\u00e9es param\u00e8tres de requ\u00eate. Ils sont une des caract\u00e9ristique du protocole HTTP.<\/p><p>La partie suivante du code d\u00e9termine s\u2019il y a un param\u00e8tre de requ\u00eate du type ?id=0, puis affecte <strong>l\u2019ID fourni \u00e0 une variable<\/strong>.<\/p><p>Ensuite, on parcourt l\u2019annuaire des employ\u00e9s, on identifie l\u2019employ\u00e9 ayant l\u2019ID sp\u00e9cifi\u00e9 et on le rajoute \u00e0 la liste renvoy\u00e9e en r\u00e9sultat.<\/p><p>Finalement, l\u2019instruction return jsonify(results) renvoie les r\u00e9sultats au format JSON pour affichage dans le navigateur.<\/p><p>A ce stade, on a cr\u00e9\u00e9 une API fonctionnelle. Dans les posts suivants, on va voir comment cr\u00e9er une API un peu plus complexe, qui utilise une <a href=\"https:\/\/datascientest.com\/bien-choisir-sa-base-de-donnees-typologie\">base de donn\u00e9es<\/a>. Les principes et instructions fondamentaux resteront toutefois les m\u00eames.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-bf28d54 e-flex e-con-boxed e-con\" data-id=\"bf28d54\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-328f55e elementor-widget elementor-widget-menu-anchor\" data-id=\"328f55e\" data-element_type=\"widget\" data-widget_type=\"menu-anchor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div id=\"API5\" class=\"elementor-menu-anchor\"><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-4e28933 elementor-widget elementor-widget-heading\" data-id=\"4e28933\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">5. Quelques principes de bonne conception des API Web<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-6fa499e elementor-widget elementor-widget-text-editor\" data-id=\"6fa499e\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Deux aspects des bonnes API sont la facilit\u00e9 d\u2019utilisation (usability) et la maintenabilit\u00e9 (maintainability). Nous garderons ces exigences pr\u00e9sentes lorsque nous programmerons des API sous Python.<\/p><p>La m\u00e9thodologie la plus r\u00e9pandue de conception des API (API design) s\u2019appelle REST.<\/p><p>L\u2019aspect le plus important de REST est qu\u2019elle est bas\u00e9e sur quatre m\u00e9thodes d\u00e9finies par le protocole HTTP : GET, POST, PUT et DELETE. Celles-ci correspondent aux quatre op\u00e9rations standard effectu\u00e9es sur une base de donn\u00e9es : READ, CREATE, UPDATE et DELETE.<\/p><p>Dans la suite, on ne s\u2019int\u00e9ressera qu\u2019aux requ\u00eates GET, qui permettent de lire dans une base de donn\u00e9es.<\/p><p>Les requ\u00eates HTTP jouent un r\u00f4le essentiel dans le cadre de la m\u00e9thodologie REST, de nombreux principes de conception gravitant autour de la fa\u00e7on dont les requ\u00eates doivent \u00eatre format\u00e9es.<\/p><p>On a d\u00e9j\u00e0 cr\u00e9\u00e9 une requ\u00eate HTTP, qui renvoyait l\u2019int\u00e9gralit\u00e9 de notre catalogue.<\/p><p>Commen\u00e7ons par une requ\u00eate mal con\u00e7ue :\u00a0<\/p><p style=\"padding-left: 40px;\"><a href=\"http:\/\/api.example.com\/getemployee\/10\">http:\/\/api.example.com\/getemployee\/10<\/a><\/p><p>Cette requ\u00eate pose un certain nombre de probl\u00e8mes : le premier est s\u00e9mantique ; dans une API REST, les verbes typiques sont GET, POST, PUT et DELETE, et sont d\u00e9termin\u00e9s par la m\u00e9thode de requ\u00eate plut\u00f4t que par l\u2019URL de requ\u00eate. Cela entra\u00eene que le mot \u00ab get \u00bb ne doit pas appara\u00eetre dans la requ\u00eate, puisque \u00ab get \u00bb est impliqu\u00e9 par le fait qu\u2019on utilise une requ\u00eate HTTP GET.<\/p><p>De plus, les collections de ressources, comme employees ou users, doivent \u00eatre d\u00e9sign\u00e9es par des noms au pluriel.<\/p><p>Cela permet d\u2019identifier facilement si l\u2019API se r\u00e9f\u00e8re \u00e0 un ensemble d\u2019employ\u00e9s (employees) ou \u00e0 un employ\u00e9 particulier (employee).<\/p><p>Ces remarques pr\u00e9sentes \u00e0 l\u2019esprit, la nouvelle forme de notre requ\u00eate est la suivante :\u00a0<\/p><p style=\"padding-left: 40px;\"><a href=\"http:\/\/api.example.com\/employees\/10\">http:\/\/api.example.com\/employees\/10<\/a><\/p><p>La requ\u00eate ci-dessus utilise une partie du chemin pour fournir l\u2019identifiant.<\/p><p>Bien que cette approche soit utilis\u00e9e en pratique, elle est trop rigide : avec des URL construites de cette fa\u00e7on, on ne peut filtrer que par un champ \u00e0 la fois.<\/p><p>Les param\u00e8tres de requ\u00eates permettent de filtrer selon plusieurs champs de la base de donn\u00e9es et de sp\u00e9cifier des donn\u00e9es suppl\u00e9mentaires, comme un format de r\u00e9ponse :<\/p><p style=\"padding-left: 40px;\"><a href=\"http:\/\/api.example.com\/employees?nom=Durand&amp;prenom=Elodie&amp;output=xml\">http:\/\/api.example.com\/employees?nom=Durand&amp;prenom=Elodie&amp;output=xml<\/a><\/p><p>Quand on met au point la structure des requ\u00eates soumises \u00e0 une API, il est \u00e9galement raisonnable de pr\u00e9voir les d\u00e9veloppements futurs.<\/p><p>Bien que la version actuelle de l\u2019API ne fournisse de l\u2019information que sur un type de ressources (employees), il fait sens d\u2019envisager qu\u2019on puisse rajouter d\u2019autres ressources ou des fonctionnalit\u00e9s \u00e0 notre API, ce qui donne :<\/p><p style=\"padding-left: 40px;\"><a href=\"http:\/\/api.example.com\/resources\/employees?id=10\">http:\/\/api.example.com\/resources\/employees?id=10<\/a><\/p><p>Sp\u00e9cifier un segment \u00ab resources \u00bb sur le chemin permet d\u2019offrir aux utilisateurs l\u2019option d\u2019acc\u00e9der \u00e0 toutes les ressources disponibles, avec des requ\u00eates du type :<\/p><p style=\"padding-left: 40px;\"><a href=\"https:\/\/api.example.com\/v1\/resources\/images?id=10\">https:\/\/api.example.com\/v1\/resources\/images?id=10<\/a><\/p><p style=\"padding-left: 40px;\"><a href=\"https:\/\/api.example.com\/v1\/resources\/all\">https:\/\/api.example.com\/v1\/resources\/all<\/a><\/p><p>Une autre fa\u00e7on d\u2019envisager les d\u00e9veloppements futurs de l\u2019API est de rajouter un num\u00e9ro de version au chemin.<\/p><p>Cela permet de continuer \u00e0 maintenir l\u2019acc\u00e8s \u00e0 l\u2019ancienne API si on est amen\u00e9 \u00e0 concevoir une nouvelle version, par exemple la v2, de l\u2019API.<\/p><p>Cela permet aux applications et aux scripts con\u00e7us avec la premi\u00e8re version de l\u2019API de continuer \u00e0 fonctionner apr\u00e8s la mise \u00e0 jour.<\/p><p>Finalement, une requ\u00eate bien con\u00e7ue, dans les cadres de la m\u00e9thodologie REST, est de la forme suivante :\u00a0<\/p><p style=\"padding-left: 40px;\"><a href=\"https:\/\/api.example.com\/v1\/resources\/employees?id=10\">https:\/\/api.example.com\/v1\/resources\/employees?id=10<\/a><\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-c48b40c e-flex e-con-boxed e-con\" data-id=\"c48b40c\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-246a465 elementor-widget elementor-widget-menu-anchor\" data-id=\"246a465\" data-element_type=\"widget\" data-widget_type=\"menu-anchor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div id=\"API6\" class=\"elementor-menu-anchor\"><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-76ba669 elementor-widget elementor-widget-heading\" data-id=\"76ba669\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">6. Exemples et documentation<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-cc36b6e elementor-widget elementor-widget-text-editor\" data-id=\"cc36b6e\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Sans documentation, m\u00eame la meilleure API est inutilisable.<\/p><blockquote><p><em>Une documentation doit \u00eatre associ\u00e9e \u00e0 l\u2019API, qui d\u00e9crit les ressources ou fonctionnalit\u00e9s disponibles via l\u2019API et fournit des exemples concrets d\u2019URLs de requ\u00eate et de code.<\/em><\/p><\/blockquote><p>Il est n\u00e9cessaire de pr\u00e9voir un paragraphe pour chaque ressource, qui d\u00e9crit les champs pouvant \u00eatre requ\u00eat\u00e9s, comme title et id.<\/p><p>Chaque paragraphe doit fournir un exemple de requ\u00eate HTTP ou un bloc de code.<\/p><p>Une pratique usuelle de la documentation des API consiste \u00e0 annoter le code, les annotations pouvant \u00eatre automatiquement regroup\u00e9es en une documentation \u00e0 l\u2019aide d\u2019outils comme <a href=\"http:\/\/www.doxygen.nl\">Doxygen<\/a> ou <a href=\"http:\/\/www.sphinx-doc.org\/en\/stable\/\">Sphinx<\/a>.<\/p><p>Ces outils g\u00e9n\u00e8rent une documentation \u00e0 partir des \u00ab docstrings \u00bb, c\u2019est-\u00e0-dire des cha\u00eenes de caract\u00e8res documentant les fonctions.<\/p><p>Bien que ce type de documentation soit pr\u00e9cieux, on ne doit pas s\u2019arr\u00eater l\u00e0. Il faut se mettre dans la peau d\u2019un utilisateur et fournir des exemples concrets d\u2019utilisation.<\/p><p>Id\u00e9alement, on doit disposer de trois types de documentation :\u00a0<\/p><ul><li>une <strong>r\u00e9f\u00e9rence<\/strong> d\u00e9taillant chaque route et son comportement ;<\/li><li>un <strong>guide<\/strong> expliquant la r\u00e9f\u00e9rence en prose ;<\/li><li>un ou deux <strong>tutoriels<\/strong> expliquant en d\u00e9tail chaque \u00e9tape.<\/li><\/ul>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-c9b766f elementor-widget elementor-widget-text-editor\" data-id=\"c9b766f\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>Pour un exemple de documentation d\u2019API, on pourra consulter le <a href=\"http:\/\/api.repo.nypl.org\">New York Public Library Digital Collections API<\/a> qui constitue un bon standard.\u00a0<\/p><p>Un autre exemple, plus fourni, est celui de la <a href=\"https:\/\/www.mediawiki.org\/wiki\/API:Main_page\">MediaWiki Action API<\/a> qui fournit de la documentation permettant aux utilisateurs de soumettre des requ\u00eates partielles \u00e0 l\u2019API.<\/p><p>Pour d\u2019autres exemples de documentation d\u2019API, on pourra consulter l\u2019<a href=\"https:\/\/datahelpdesk.worldbank.org\/knowledgebase\/articles\/889392-api-documentation\">API de la Banque Mondiale<\/a> et l\u2019<a href=\"https:\/\/pro.europeana.eu\/resources\/apis\">API European Pro<\/a>.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-46f8808 e-flex e-con-boxed e-con\" data-id=\"46f8808\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-629d6a8 elementor-widget elementor-widget-menu-anchor\" data-id=\"629d6a8\" data-element_type=\"widget\" data-widget_type=\"menu-anchor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<div id=\"API7\" class=\"elementor-menu-anchor\"><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-f0d4e1e elementor-widget elementor-widget-heading\" data-id=\"f0d4e1e\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">7. R\u00e9f\u00e9rences bibliographiques<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-a4c3108 elementor-widget elementor-widget-text-editor\" data-id=\"a4c3108\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<ul><li><em>Creating Web APIs with Python and Flask, Patrick Smyth : <a href=\"https:\/\/programminghistorian.org\/en\/lessons\/creating-apis-with-python-and-flask\">https:\/\/programminghistorian.org\/en\/lessons\/creating-apis-with-python-and-flask<\/a><\/em><\/li><li><em>Flask RESTful documentation : <a href=\"https:\/\/flask-restful.readthedocs.io\/en\/latest\/index.html\">https:\/\/flask-restful.readthedocs.io\/en\/latest\/index.html<\/a><\/em><\/li><li><em>Flask Web Development : Developing Web Applications with Python (2\u00e8me \u00e9dition). M. Grinberg. O\u2019Reilly 2018.<\/em><\/li><li><em>Architectural Styles and the Design of Network-Based Software Architectures. Fielding. Th\u00e8se, Universit\u00e9 de Californie, 2000.<\/em><\/li><\/ul>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>L\u2019article va traiter de la programmation d\u2019API (Application Programming Interfaces) Web sous Python. Celles-ci sont des outils permettant de rendre accessibles de l\u2019information et des fonctionnalit\u00e9s via internet. Vous pouvez \u00e9galement d\u00e9couvrir comment connecter une API \u00e0 une base de donn\u00e9es sous python et comment programmer et documenter une API avec python, flask, swagger et [&hellip;]<\/p>\n","protected":false},"author":95,"featured_media":161724,"comment_status":"open","ping_status":"open","sticky":false,"template":"elementor_theme","format":"standard","meta":{"content-type":"","inline_featured_image":false},"categories":[2497],"tags":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v21.7 (Yoast SEO v21.7) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Programmation d\u2019API Web sous Python avec Flask<\/title>\n<meta name=\"description\" content=\"L\u2019article va traiter de la programmation d\u2019API (Application Programming Interfaces) Web sous Python. Celles-ci sont des outils permettant de rendre accessibles de l\u2019information et des fonctionnalit\u00e9s via internet.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Programmation d\u2019API Web sous Python avec Flask\" \/>\n<meta property=\"og:url\" content=\"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask\" \/>\n<meta property=\"og:site_name\" content=\"Formation Data Science | DataScientest.com\" \/>\n<meta property=\"article:published_time\" content=\"2022-02-15T16:30:33+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-09-26T13:07:28+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/02\/api_flask_blog_4-91.png\" \/>\n\t<meta property=\"og:image:width\" content=\"2560\" \/>\n\t<meta property=\"og:image:height\" content=\"1405\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Salim Lardjane\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"\u00c9crit par\" \/>\n\t<meta name=\"twitter:data1\" content=\"Salim Lardjane\" \/>\n\t<meta name=\"twitter:label2\" content=\"Dur\u00e9e de lecture estim\u00e9e\" \/>\n\t<meta name=\"twitter:data2\" content=\"14 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask\",\"url\":\"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask\",\"name\":\"Programmation d\u2019API Web sous Python avec Flask\",\"isPartOf\":{\"@id\":\"https:\/\/datascientest.com\/#website\"},\"datePublished\":\"2022-02-15T16:30:33+00:00\",\"dateModified\":\"2024-09-26T13:07:28+00:00\",\"author\":{\"@id\":\"https:\/\/datascientest.com\/#\/schema\/person\/117e8a03bd4dcdb2740a26887f660ff3\"},\"description\":\"L\u2019article va traiter de la programmation d\u2019API (Application Programming Interfaces) Web sous Python. Celles-ci sont des outils permettant de rendre accessibles de l\u2019information et des fonctionnalit\u00e9s via internet.\",\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask\"]}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/datascientest.com\/#website\",\"url\":\"https:\/\/datascientest.com\/\",\"name\":\"Formation Data Science | DataScientest.com\",\"description\":\"Leader de la formation en Data Science\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/datascientest.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"fr-FR\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/datascientest.com\/#\/schema\/person\/117e8a03bd4dcdb2740a26887f660ff3\",\"name\":\"Salim Lardjane\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\/\/datascientest.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/datascientest.com\/wp-content\/uploads\/2024\/09\/1712345903860.jpg\",\"contentUrl\":\"https:\/\/datascientest.com\/wp-content\/uploads\/2024\/09\/1712345903860.jpg\",\"caption\":\"Salim Lardjane\"},\"description\":\"Salim Lardjane est ma\u00eetre de conf\u00e9rences en statistique \u00e0 l'Universit\u00e9 Bretagne Sud, o\u00f9 il enseigne depuis plus de 20 ans. Ses recherches actuelles se concentrent sur les th\u00e8mes suivants : data art, data visualisation, design de l'information, esth\u00e9tique fonctionnelle.\",\"sameAs\":[\"https:\/\/www.linkedin.com\/in\/salim-lardjane-78a445117\/\"],\"jobTitle\":\"Ma\u00eetre de Conf\u00e9rences | Statistique\",\"url\":\"https:\/\/datascientest.com\/author\/salimlardjane\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Programmation d\u2019API Web sous Python avec Flask","description":"L\u2019article va traiter de la programmation d\u2019API (Application Programming Interfaces) Web sous Python. Celles-ci sont des outils permettant de rendre accessibles de l\u2019information et des fonctionnalit\u00e9s via internet.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask","og_locale":"fr_FR","og_type":"article","og_title":"Programmation d\u2019API Web sous Python avec Flask","og_url":"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask","og_site_name":"Formation Data Science | DataScientest.com","article_published_time":"2022-02-15T16:30:33+00:00","article_modified_time":"2024-09-26T13:07:28+00:00","og_image":[{"width":2560,"height":1405,"url":"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/02\/api_flask_blog_4-91.png","type":"image\/png"}],"author":"Salim Lardjane","twitter_card":"summary_large_image","twitter_misc":{"\u00c9crit par":"Salim Lardjane","Dur\u00e9e de lecture estim\u00e9e":"14 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask","url":"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask","name":"Programmation d\u2019API Web sous Python avec Flask","isPartOf":{"@id":"https:\/\/datascientest.com\/#website"},"datePublished":"2022-02-15T16:30:33+00:00","dateModified":"2024-09-26T13:07:28+00:00","author":{"@id":"https:\/\/datascientest.com\/#\/schema\/person\/117e8a03bd4dcdb2740a26887f660ff3"},"description":"L\u2019article va traiter de la programmation d\u2019API (Application Programming Interfaces) Web sous Python. Celles-ci sont des outils permettant de rendre accessibles de l\u2019information et des fonctionnalit\u00e9s via internet.","inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask"]}]},{"@type":"WebSite","@id":"https:\/\/datascientest.com\/#website","url":"https:\/\/datascientest.com\/","name":"Formation Data Science | DataScientest.com","description":"Leader de la formation en Data Science","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/datascientest.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"fr-FR"},{"@type":"Person","@id":"https:\/\/datascientest.com\/#\/schema\/person\/117e8a03bd4dcdb2740a26887f660ff3","name":"Salim Lardjane","image":{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/datascientest.com\/#\/schema\/person\/image\/","url":"https:\/\/datascientest.com\/wp-content\/uploads\/2024\/09\/1712345903860.jpg","contentUrl":"https:\/\/datascientest.com\/wp-content\/uploads\/2024\/09\/1712345903860.jpg","caption":"Salim Lardjane"},"description":"Salim Lardjane est ma\u00eetre de conf\u00e9rences en statistique \u00e0 l'Universit\u00e9 Bretagne Sud, o\u00f9 il enseigne depuis plus de 20 ans. Ses recherches actuelles se concentrent sur les th\u00e8mes suivants : data art, data visualisation, design de l'information, esth\u00e9tique fonctionnelle.","sameAs":["https:\/\/www.linkedin.com\/in\/salim-lardjane-78a445117\/"],"jobTitle":"Ma\u00eetre de Conf\u00e9rences | Statistique","url":"https:\/\/datascientest.com\/author\/salimlardjane"}]}},"_links":{"self":[{"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/posts\/140363"}],"collection":[{"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/users\/95"}],"replies":[{"embeddable":true,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/comments?post=140363"}],"version-history":[{"count":0,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/posts\/140363\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/media\/161724"}],"wp:attachment":[{"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/media?parent=140363"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/categories?post=140363"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/tags?post=140363"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}