{"id":162993,"date":"2022-04-12T17:09:07","date_gmt":"2022-04-12T16:09:07","guid":{"rendered":"https:\/\/datascientest.com\/?p=153720"},"modified":"2024-09-26T13:07:18","modified_gmt":"2024-09-26T13:07:18","slug":"programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion","status":"publish","type":"post","link":"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion","title":{"rendered":"Programmer et documenter une API avec Python, Flask, Swagger et Connexion"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-post\" data-elementor-id=\"162993\" class=\"elementor elementor-162993\" data-elementor-post-type=\"post\">\n\t\t\t\t\t\t\t\t\t<section class=\"elementor-section elementor-top-section elementor-element elementor-element-bf33797 elementor-section-boxed elementor-section-height-default elementor-section-height-default\" data-id=\"bf33797\" data-element_type=\"section\">\n\t\t\t\t\t\t<div class=\"elementor-container elementor-column-gap-default\">\n\t\t\t\t\t<div class=\"elementor-column elementor-col-100 elementor-top-column elementor-element elementor-element-1f43021\" data-id=\"1f43021\" data-element_type=\"column\">\n\t\t\t<div class=\"elementor-widget-wrap elementor-element-populated\">\n\t\t\t\t\t\t\t\t<div class=\"elementor-element elementor-element-6771694 elementor-widget elementor-widget-text-editor\" data-id=\"6771694\" 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<h2><strong><span style=\"color: #000000;\">On a vu dans les deux pr\u00e9c\u00e9dents articles un premier exemple de <span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"https:\/\/datascientest.com\/programmation-dapi-web-sous-python-avec-flask\">programmation d\u2019une API Web sous Flask<\/a><\/span> et <a href=\"https:\/\/datascientest.com\/connecter-une-api-a-une-base-de-donnees-sous-python\"><span style=\"color: #5e36f3;\">comment connecter une API Web \u00e0 une base de donn\u00e9e SqLite.\u00a0<\/span><\/a><\/span><\/strong><\/h2>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-6d3a1e6 elementor-widget elementor-widget-text-editor\" data-id=\"6d3a1e6\" 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 va voir dans la suite comment construire des API REST avec validation des inputs et des outputs et documentation automatiquement ge\u0301ne\u0301re\u0301e par Swagger\/OpenAPI. On verra e\u0301galement comment utiliser l\u2019API avec JavaScript pour mettre a\u0300 jour le DOM (Document Object Model) c\u2019est-a\u0300-dire la structure de la page web affiche\u0301e. L\u2019API REST qu\u2019on va construire permettra de manipuler un annuaire de personnes, celles-ci e\u0301tant identifie\u0301es par leur nom de famille. Les mises a\u0300 jour seront marque\u0301es avec un \u00ab timestamp \u00bb (date\/heure). On pourrait manipuler l\u2019annuaire sous la forme d\u2019une base de donne\u0301es, d\u2019un fichier, ou via un protocole re\u0301seau, mais pour simplifier les choses dans un premier temps, on utilisera des donne\u0301es en me\u0301moire.\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-248352f elementor-widget elementor-widget-text-editor\" data-id=\"248352f\" 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<blockquote><p><span style=\"color: #000000;\"><b>Un des objectifs des APIs est de de\u0301coupler les donne\u0301es des applications qui les utilisent, en rendant transparents les de\u0301tails de l\u2019imple\u0301mentation des donne\u0301es.<\/b><\/span><\/p><\/blockquote>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-4987a38 elementor-widget elementor-widget-text-editor\" data-id=\"4987a38\" 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<ol><li><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"#API1\"><b>La m\u00e9thodologie REST<\/b><\/a><\/span><\/li><li><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"#API2\"><b>Ce que REST n\u2019est pas<\/b><\/a><\/span><\/li><li><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"#API3\"><b>Premiers pas<\/b><\/a><\/span><\/li><li><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"#API4\"><b>Connexion<\/b><\/a><\/span><\/li><li><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"#API5\"><b>Swagger\/OpenAPI<\/b><\/a><\/span><\/li><li><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"#API6\"><b>API Compl\u00e8te<\/b><\/a><\/span><\/li><li><a href=\"#API7\"><span style=\"color: #5e36f3;\"><strong>Application Web<\/strong><\/span><\/a><\/li><li><a href=\"#API8\"><strong><span style=\"color: #5e36f3;\">R\u00e9f\u00e9rences bibliographiques<\/span><\/strong><\/a><\/li><\/ol>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-b021dc1 elementor-widget elementor-widget-menu-anchor\" data-id=\"b021dc1\" 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-0920a2f elementor-widget elementor-widget-heading\" data-id=\"0920a2f\" 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\">1. La m\u00e9thodologie REST<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-1872a6c elementor-widget elementor-widget-text-editor\" data-id=\"1872a6c\" 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><span style=\"font-weight: 400;\"><span style=\"color: #000000;\">On a mentionne\u0301 la<\/span> <strong><span style=\"color: #6e4bec;\">me\u0301thodologie REST<\/span><\/strong> <span style=\"color: #000000;\">dans le premier article. On va a\u0300 pre\u0301sent l\u2019examiner plus en de\u0301tail.<\/span><\/span><\/p><p><strong><span style=\"color: #6e4bec;\">On peut voir REST comme un ensemble de conventions tirant parti du protocole HTTP pour fournir des outils CRUD (Create, Read, Update, Delete) agissant sur des entit\u00e9s ou des collections d\u2019entit\u00e9s sur lnternet.<\/span><\/strong><\/p><p><span style=\"font-weight: 400; color: #000000;\">CRUD peut e\u0302tre mis en correspondance avec HTTP de la fac\u0327on suivante :<\/span><\/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-43c6bff elementor-widget elementor-widget-text-editor\" data-id=\"43c6bff\" 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><span style=\"font-weight: 400; color: #000000;\">On peut effectuer chacune de ces actions sur une entit\u00e9 ou une ressource.<\/span><\/p><p><span style=\"font-weight: 400;\"><span style=\"color: #000000;\">On peut voir une ressource comme une entit\u00e9 \u00e0 laquelle on peut associer un nom : une personne, une adresse, une transaction.<\/span><\/span><\/p><p><span style=\"color: #000000;\">L\u2019id\u00e9e de ressource peut \u00eatre <strong><span style=\"color: #6e4bec;\">mise en correspondance avec celle d\u2019URL<\/span><\/strong>, comme on l\u2019a vu dans le premier article.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Une URL doit <strong><span style=\"color: #6e4bec;\">identifier une ressource unique sur le Web,<\/span><\/strong> quelque chose qui correspond toujours \u00e0 la m\u00eame URL.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Avec les concepts de ressource et d\u2019URL, on est \u00e0 m\u00eame de <strong><span style=\"color: #6e4bec;\">concevoir des applications<\/span><\/strong> agissant sur des choses identifi\u00e9es de fa\u00e7on unique sur le Web.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">C\u2019est une premi\u00e8re \u00e9tape vers la conception d\u2019APIs \u00e0 proprement parler, permettant d\u2019effectuer les actions souhait\u00e9es via le r\u00e9seau.<\/span><\/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-5ea5a0b elementor-widget elementor-widget-menu-anchor\" data-id=\"5ea5a0b\" 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-c994f89 elementor-widget elementor-widget-heading\" data-id=\"c994f89\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">2. Ce que REST n\u2019est pas<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-974649c elementor-widget elementor-widget-text-editor\" data-id=\"974649c\" 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><span style=\"font-weight: 400; color: #000000;\">La m\u00e9thodologie REST \u00e9tant tr\u00e8s utile et aidant \u00e0 mettre au point la fa\u00e7on dont on interagit avec une API, elle est <\/span><span style=\"color: #6e4bec;\"><b>parfois utilis\u00e9e \u00e0 tort<\/b><\/span><span style=\"font-weight: 400; color: #000000;\">, pour des probl\u00e8mes auxquels elle n\u2019est pas adapt\u00e9e.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Dans de nombreux cas, on souhaite effectuer une action directement. Prenons l\u2019exemple de la substitution d\u2019une cha\u00eene de caract\u00e8res.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Voici un exemple d\u2019URL permettant <\/span><i><span style=\"font-weight: 400;\">a priori<\/span><\/i><span style=\"font-weight: 400;\"> de le faire :<\/span><\/span><\/p><p><b style=\"color: #6e4bec;\" data-stringify-type=\"bold\">\/api\/substituteString\/&lt;string&gt;\/&lt;search_string&gt;\/&lt;sub_string&gt;\u00a0<\/b><\/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-db3a83e elementor-widget elementor-widget-text-editor\" data-id=\"db3a83e\" 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><span style=\"font-weight: 400; color: #000000;\">Ici, d\u00e9signe la cha\u00eene sur laquelle on veut faire la substitution, est la sous-cha\u00eene \u00e0 remplacer et est la nouvelle sous-cha\u00eene.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">On peut tr\u00e8s certainement concevoir un code sur le serveur qui permette d\u2019effectuer l\u2019op\u00e9ration souhait\u00e9e, mais cela pose des probl\u00e8mes en termes de REST.<\/span><\/p><ul><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400; color: #000000;\">Premier probl\u00e8me : l\u2019URL ne pointe pas vers une ressource unique ; ainsi ce qu\u2019elle renvoie d\u00e9pend enti\u00e8rement du chemin sp\u00e9cifi\u00e9.<\/span><\/li><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400; color: #000000;\">Deuxi\u00e8me probl\u00e8me : Aucun concept CRUD ne correspond \u00e0 cette URL.<\/span><\/li><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400; color: #000000;\">Troisi\u00e8me probl\u00e8me : la signification des variables de chemin d\u00e9pend de leur position dans l\u2019URL.<\/span><\/li><\/ul><p><span style=\"font-weight: 400; color: #000000;\">On pourrait corriger cela en modifiant l\u2019URL de fa\u00e7on \u00e0 utiliser une requ\u00eate :<\/span><\/p><p><b style=\"color: #6e4bec;\" data-stringify-type=\"bold\">\/api\/substituteString? string=&lt;string&gt;&amp;search_string=&lt;search_string&gt;&amp;sub_string=&lt;sub_string&gt;\u00a0<\/b><\/p><p>Mais la portion d\u2019URL \/api\/substituteString ne d\u00e9signe pas une\u00a0<b data-stringify-type=\"bold\">entit\u00e9<\/b>\u00a0(n\u2019est pas un nom) ou une<br \/>collection\u00a0<b data-stringify-type=\"bold\">d&rsquo;entit\u00e9s<\/b>\u00a0: elle d\u00e9signe une action (c\u2019est un verbe).<\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Cela ne rentre pas dans le cadre des conventions REST et de ce fait ne correspond pas \u00e0 une API. Ce que l\u2019URL pr\u00e9c\u00e9dente repr\u00e9sente est en fait un <\/span><span style=\"color: #6e4bec;\"><b>RPC<\/b><\/span><span style=\"font-weight: 400;\"> (Remote Procedure Call).<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Conceptualiser ce qu\u2019on veut faire comme un RPC est plus pertinent. Cela d\u2019autant plus que les conventions REST et RPC peuvent coexister sans probl\u00e8me au sein d\u2019une API.<\/span><\/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-5591a66 elementor-widget elementor-widget-menu-anchor\" data-id=\"5591a66\" 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=\"API3\" 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-7eef21d elementor-widget elementor-widget-heading\" data-id=\"7eef21d\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">3. Premiers pas<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-a050fc2 elementor-widget elementor-widget-text-editor\" data-id=\"a050fc2\" 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><span style=\"font-weight: 400; color: #000000;\">Dans l\u2019exemple suivant, on va mettre au point une API REST permettant d\u2019acc\u00e9der \u00e0 un annuaire de personnes et d\u2019effectuer des op\u00e9rations CRUD sur celui-ci.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Voici le design de l\u2019API :<\/span><\/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-fa6a0ab elementor-widget elementor-widget-text-editor\" data-id=\"fa6a0ab\" 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><span style=\"font-weight: 400; color: #000000;\">On va commencer par cr\u00e9er un serveur web tr\u00e8s simple \u00e0 l\u2019aide du cadre de d\u00e9veloppement Flask.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">On cr\u00e9e un r\u00e9pertoire <\/span><span style=\"color: #6e4bec;\"><b>api<\/b><\/span><span style=\"font-weight: 400;\">, <span style=\"color: #000000;\">un sous-r\u00e9pertoire <\/span><\/span><span style=\"color: #6e4bec;\"><b>version_1<\/b><\/span><span style=\"font-weight: 400;\"><span style=\"color: #6e4bec;\">,<\/span> <span style=\"color: #000000;\">puis un sous-r\u00e9pertoire <\/span><\/span><span style=\"color: #6e4bec;\"><b>templates<\/b><\/span><span style=\"font-weight: 400; color: #000000;\"> ou on sauvegarde les programmes suivants :<\/span><\/p><p><span style=\"color: #6e4bec;\"><b>server.py<\/b><\/span><\/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-b5b90dc elementor-widget elementor-widget-shortcode\" data-id=\"b5b90dc\" 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\/adrianalazureanu\/81a6f73c741cb9de9f129019704e0183.js\"><\/script><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-99c429a elementor-widget elementor-widget-text-editor\" data-id=\"99c429a\" 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><span style=\"color: #6e4bec;\"><b>templates\/home.html<\/b><\/span><\/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-c24acde elementor-widget elementor-widget-shortcode\" data-id=\"c24acde\" 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\/adrianalazureanu\/c5592e4a6fe6792aa9808bc48265d6b4.js\"><\/script><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-5372df1 elementor-widget elementor-widget-text-editor\" data-id=\"5372df1\" 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><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Le programme HTML est nomm\u00e9 <\/span><span style=\"color: #6e4bec;\"><b>home.html<\/b><\/span><span style=\"font-weight: 400;\"> plut\u00f4t que <\/span><span style=\"color: #6e4bec;\"><b>index.html<\/b><\/span><span style=\"font-weight: 400;\"> comme il est d\u2019usage, car <\/span><span style=\"color: #6e4bec;\"><b>index.html <\/b><\/span><span style=\"font-weight: 400;\">pose probl\u00e8me lorsqu\u2019on importe le module Connexion, ce qu\u2019on fera dans la suite.<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">On lance une fen\u00eatre Terminal, on se place dans le r\u00e9pertoire <\/span><span style=\"color: #6e4bec;\"><b>projects\/api\/version_1<\/b><\/span><span style=\"font-weight: 400;\"> et on lance l\u2019application en saisissant successivement :<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">$ export FLASK_APP = server.py<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">$ export FLASK_ENV = development<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">$ flask run<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">On obtient le r\u00e9sultat suivant en saisissant http:\/\/127.0.0.1:5000 dans la barre du navigateur :<\/span><\/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-da95d1e elementor-widget elementor-widget-image\" data-id=\"da95d1e\" 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\/04\/unnamed-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-60dc5bc elementor-widget elementor-widget-menu-anchor\" data-id=\"60dc5bc\" 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-0cb9fe4 elementor-widget elementor-widget-heading\" data-id=\"0cb9fe4\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">4. Connexion<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-3c74e53 elementor-widget elementor-widget-text-editor\" data-id=\"3c74e53\" 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><span style=\"font-weight: 400; color: #000000;\">\u00c0 pr\u00e9sent qu\u2019on a un service Web fonctionnel, on va ajouter un chemin d\u2019acc\u00e8s REST (REST API endpoint). \u00c0 cet effet, on va installer le module Connexion.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Pour cela, on saisit dans une fen\u00eatre terminal (cela suppose qu\u2019on travaille sous <\/span><a style=\"color: #000000;\" href=\"https:\/\/www.anaconda.com\/\"><span style=\"font-weight: 400;\">Anaconda<\/span><\/a><span style=\"font-weight: 400;\">) :<\/span><\/span><\/p><p><span style=\"color: #6e4bec;\"><b>$ conda install -c conda-forge connexion<\/b><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">On peut \u00e0 pr\u00e9sent l\u2019importer sous Python.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">On cr\u00e9e ensuite un sous-r\u00e9pertoire <\/span><span style=\"color: #6e4bec;\"><b>version_2<\/b><\/span><span style=\"font-weight: 400;\"> dans le r\u00e9pertoire <\/span><span style=\"color: #6e4bec;\"><b>api<\/b><\/span><span style=\"font-weight: 400;\"> et on y sauvegarde les programmes suivants :<\/span><\/span><\/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-84b11b3 elementor-widget elementor-widget-heading\" data-id=\"84b11b3\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">server.py<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-472f22b elementor-widget elementor-widget-shortcode\" data-id=\"472f22b\" 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\/adrianalazureanu\/d0e84b1451795fe56a0a98c8b3912e22.js\"><\/script><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-540689e elementor-widget elementor-widget-heading\" data-id=\"540689e\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">swagger.yml<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-9abfab4 elementor-widget elementor-widget-shortcode\" data-id=\"9abfab4\" 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\/adrianalazureanu\/08d5dae63be1888cf4878af7370b5921.js\"><\/script><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-79bd93f elementor-widget elementor-widget-text-editor\" data-id=\"79bd93f\" 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><span style=\"font-weight: 400; color: #000000;\">Afin d\u2019utiliser Connexion, on commence par l\u2019importer, puis on cr\u00e9e l\u2019application \u00e0 l\u2019aide de Connexion plut\u00f4t que Flask. L\u2019application Flask est quand m\u00eame cr\u00e9\u00e9e de fa\u00e7on sous-jacente, mais avec des fonctionnalit\u00e9s additionnelles.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">La cr\u00e9ation de l\u2019instance de l\u2019application comprend un param\u00e8tre <\/span><span style=\"color: #6e4bec;\"><b>specification_dir<\/b><\/span><span style=\"font-weight: 400;\">. Il indique \u00e0 Connexion o\u00f9 trouver le fichier de configuration, ici le r\u00e9pertoire courant.<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">La ligne <\/span><span style=\"color: #6e4bec;\"><b>app.add_api (\u2018swagger.yml\u2019)<\/b><\/span><span style=\"font-weight: 400;\"> indique \u00e0 l\u2019instance de lire le fichier <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml <\/b><\/span><span style=\"font-weight: 400;\">dans le <\/span><span style=\"color: #6e4bec;\"><b>specification_dir<\/b><\/span><span style=\"font-weight: 400;\"> et de configurer le syst\u00e8me pour Connexion.<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Le fichier <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml<\/b><\/span><span style=\"font-weight: 400;\"> est un fichier YAML (ou JSON) contenant l\u2019information n\u00e9cessaire \u00e0 la configuration du serveur, permettant d\u2019assurer la validation des inputs et des outputs, de fournir les URL de requ\u00eate et de configurer l\u2019interface utilisateur (UI) Swagger.<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Le code pr\u00e9c\u00e9dent d\u00e9finit la requ\u00eate GET \/ api\/people. Le code est organis\u00e9 de mani\u00e8re hi\u00e9rarchique, l\u2019indentation d\u00e9finissant le degr\u00e9 d\u2019appartenance ou port\u00e9e.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Par exemple, <\/span><span style=\"color: #6e4bec;\"><b>paths<\/b><\/span><span style=\"font-weight: 400;\"> d\u00e9finit la racine de toutes les URL de l\u2019API. La valeur <\/span><b>\/<span style=\"color: #6e4bec;\">people<\/span><\/b><span style=\"font-weight: 400;\"> indent\u00e9e \u00e0 la suite d\u00e9finit la racine de toutes les URL \/api\/people. Le <\/span><b><span style=\"color: #6e4bec;\">get<\/span> :<\/b><span style=\"font-weight: 400;\"> indent\u00e9 \u00e0 la suite d\u00e9finit une requ\u00eate GET vers l\u2019URL<\/span><span style=\"color: #6e4bec;\"><b> \/api\/people<\/b><\/span><span style=\"font-weight: 400;\">, et ainsi de suite pour tout le fichier de configuration.<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Dans le fichier <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml<\/b><\/span><span style=\"font-weight: 400;\">, on configure Connexion avec la valeur <\/span><span style=\"color: #6e4bec;\"><b>operationId<\/b><\/span><span style=\"font-weight: 400;\"> pour appeler le module <\/span><span style=\"color: #6e4bec;\"><b>people<\/b><\/span><span style=\"font-weight: 400;\"> et la fonction <\/span><span style=\"color: #6e4bec;\"><b>read<\/b><\/span><span style=\"font-weight: 400;\"> de ce module quand l\u2019API re\u00e7oit une requ\u00eate HTTP du type <\/span><span style=\"color: #6e4bec;\"><b>GET \/api\/people<\/b><\/span><span style=\"font-weight: 400;\">. Cela signifie qu\u2019un module <\/span><span style=\"color: #6e4bec;\"><b>people.py<\/b><\/span><span style=\"font-weight: 400;\"> doit exister et contenir une fonction read( ).<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Voici le module people.py :<\/span><\/p><p><span style=\"color: #6e4bec;\"><b>people.py<\/b><\/span><\/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-d109f5f elementor-widget elementor-widget-shortcode\" data-id=\"d109f5f\" 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\/adrianalazureanu\/33467c6be62b2a7661049d5c6e86720a.js\"><\/script><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-5745fe8 elementor-widget elementor-widget-text-editor\" data-id=\"5745fe8\" 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><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Dans le module <\/span><span style=\"color: #6e4bec;\"><b>people.py<\/b><\/span><span style=\"font-weight: 400;\"> appara\u00eet d\u2019abord la fonction <\/span><span style=\"color: #6e4bec;\"><b>get_timestamp( )<\/b><\/span><span style=\"font-weight: 400;\"> qui g\u00e9n\u00e8re une repr\u00e9sentation de la date\/heure courante sous la forme d\u2019une cha\u00eene de caract\u00e8res. Elle est utilis\u00e9e pour modifier les donn\u00e9es quand une requ\u00eate de modification est transmise \u00e0 l\u2019API.<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Ensuite, on d\u00e9finit un dictionnaire PEOPLE qui est une simple base de donn\u00e9es de noms, ayant comme cl\u00e9 le nom de famille.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">PEOPLE est une variable de module et son \u00e9tat persiste donc entre les appels \u00e0 l\u2019API.<\/span><\/p><p><span style=\"color: #6e4bec;\"><b>Dans une application r\u00e9elle, les donn\u00e9es PEOPLE se trouveraient dans une base de donn\u00e9es, un fichier ou une ressource Web, c\u2019est-\u00e0-dire qu\u2019elles persisteraient ind\u00e9pendamment de l\u2019ex\u00e9cution de l\u2019application<\/b><i><span style=\"font-weight: 400;\">.<\/span><\/i><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Vient ensuite la fonction read( ) qui est appel\u00e9e lorsque le serveur re\u00e7oit une requ\u00eate HTTP GET pour \/api\/people.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">La valeur de retour de cette fonction est convertie au format JSON (comme sp\u00e9cifi\u00e9 par <\/span><span style=\"color: #6e4bec;\"><b>produces :<\/b><\/span><span style=\"font-weight: 400;\"> dans le fichier de configuration <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml<\/b><span style=\"font-weight: 400;\">).<\/span><\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Elle consiste en la liste des personnes tri\u00e9e par ordre alphab\u00e9tique du nom de famille. \u00c0 ce stade, on peut ex\u00e9cuter le programme <\/span><span style=\"color: #6e4bec;\"><b>server.py<\/b><\/span><span style=\"font-weight: 400;\"> \u00e0 l\u2019aide de la command :<\/span><\/span><\/p><p><span style=\"color: #6e4bec;\"><b>$ python server.py<\/b><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">ce qui donne le r\u00e9sultat suivant en saisissant comme adresse <\/span><span style=\"color: #6e4bec;\"><b>http:\/\/0.0.0.0:8080\/api\/people<\/b><\/span><span style=\"font-weight: 400;\"> dans la barre du navigateur :<\/span><\/span><\/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-9b24c6e elementor-widget elementor-widget-image\" data-id=\"9b24c6e\" 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\/04\/unnamed-2.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-40b3728 elementor-widget elementor-widget-menu-anchor\" data-id=\"40b3728\" 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-41afaf3 elementor-widget elementor-widget-heading\" data-id=\"41afaf3\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">5. Swagger\/OpenAPI<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-a03644e elementor-widget elementor-widget-text-editor\" data-id=\"a03644e\" 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><span style=\"font-weight: 400; color: #000000;\">On a ainsi construit une API simple autorisant une seule requ\u00eate. On peut toutefois se poser la question suivante, d\u2019autant plus qu\u2019on a vu comment obtenir le m\u00eame r\u00e9sultat beaucoup plus simplement avec Flask dans notre premier article :\u00a0<\/span><\/p><p><span style=\"color: #000000;\"><i><span style=\"font-weight: 400;\">Qu\u2019apporte la configuration \u00e0 l\u2019aide du fichier <strong><span style=\"color: #6e4bec;\">swagger.yml<\/span><\/strong> ?<\/span><\/i><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">En fait, en plus de l\u2019API une Interface Utilisateur (UI) Swagger (OpenAPI) a \u00e9t\u00e9 cr\u00e9\u00e9e par Connexion. Pour y acc\u00e9der, il suffit de saisir <\/span><span style=\"color: #6e4bec;\"><b>http:\/\/localhost:8080\/api\/ui<\/b><span style=\"font-weight: 400;\">.<\/span><\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">\u00a0On obtient le r\u00e9sultat suivant :<\/span><\/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-74be72a elementor-widget elementor-widget-image\" data-id=\"74be72a\" 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\/04\/unnamed-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-a229ef1 elementor-widget elementor-widget-text-editor\" data-id=\"a229ef1\" 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><span style=\"font-weight: 400; color: #000000;\">En cliquant sur People, la requ\u00eate potentielle appara\u00eet :<\/span><\/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-a65d449 elementor-widget elementor-widget-image\" data-id=\"a65d449\" 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\/04\/unnamed-4.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-2659c09 elementor-widget elementor-widget-text-editor\" data-id=\"2659c09\" 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><span style=\"font-weight: 400; color: #000000;\">En cliquant sur la requ\u00eate, les informations suppl\u00e9mentaires suivantes sont affich\u00e9es par l\u2019interface :<\/span><\/p><ul><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400; color: #000000;\">La structure de la r\u00e9ponse<\/span><\/li><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400; color: #000000;\">Le format de la r\u00e9ponse (content-type)<\/span><\/li><\/ul><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Le texte renseign\u00e9 dans <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml<\/b><\/span><span style=\"font-weight: 400;\"> \u00e0 propos de la requ\u00eate<\/span><\/span><\/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-e4dc9fe elementor-widget elementor-widget-image\" data-id=\"e4dc9fe\" 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\" width=\"512\" height=\"341\" src=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/04\/unnamed-5-1.png\" class=\"attachment-large size-large wp-image-153829\" alt=\"\" srcset=\"https:\/\/datascientest.com\/wp-content\/uploads\/2022\/04\/unnamed-5-1.png 512w, https:\/\/datascientest.com\/wp-content\/uploads\/2022\/04\/unnamed-5-1-300x200.png 300w\" sizes=\"(max-width: 512px) 100vw, 512px\" \/>\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-e0ac3f5 elementor-widget elementor-widget-text-editor\" data-id=\"e0ac3f5\" 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><span style=\"font-weight: 400; color: #000000;\">On peut m\u00eame essayer la requ\u00eate en cliquant sur le bouton <\/span><span style=\"color: #6e4bec;\"><b>Try It Out ! <\/b><\/span><span style=\"font-weight: 400; color: #000000;\">en bas de l\u2019\u00e9cran.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">L\u2019interface d\u00e9veloppe encore plus l\u2019affichage et on obtient \u00e0 la suite :<\/span><\/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-8daad66 elementor-widget elementor-widget-image\" data-id=\"8daad66\" 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\/04\/unnamed-6.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-afe50e1 elementor-widget elementor-widget-text-editor\" data-id=\"afe50e1\" 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><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Tout cela est tr\u00e8s utile lorsqu\u2019on dispose d\u2019une API compl\u00e8te puisque cela permet de tester et d\u2019exp\u00e9rimenter avec l\u2019API sans \u00e9crire de code.<\/span><span style=\"font-weight: 400;\"> En plus d\u2019\u00eatre pratique pour acc\u00e9der \u00e0 la documentation, l\u2019interface Swagger\/OpenAPI a l\u2019avantage d\u2019\u00eatre mise \u00e0 jour d\u00e8s que le fichier <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml<\/b><\/span><span style=\"font-weight: 400;\"> est mis \u00e0 jour.<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">De plus, le fichier <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml <\/b><\/span><span style=\"font-weight: 400;\">fournit une fa\u00e7on m\u00e9thodique de concevoir l\u2019ensemble des requ\u00eates, ce qui permet d\u2019assurer une conception rigoureuse de l\u2019API. Enfin, cela permet de d\u00e9coupler le code Python de la configuration des requ\u00eates, ce qui peut s\u2019av\u00e9rer tr\u00e8s utile lorsqu\u2019on con\u00e7oit des API supportant des applications Web. On en verra un exemple dans la suite.<\/span><\/span><\/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-a650e56 elementor-widget elementor-widget-menu-anchor\" data-id=\"a650e56\" 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-b6235ec elementor-widget elementor-widget-heading\" data-id=\"b6235ec\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">6. API Compl\u00e8te<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-8ade4fc elementor-widget elementor-widget-text-editor\" data-id=\"8ade4fc\" 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><span style=\"font-weight: 400; color: #000000;\">Notre objectif \u00e9tait de cr\u00e9er une API offrant un acc\u00e8s CRUD \u00e0 nos donn\u00e9es PEOPLE. \u00c0 cet effet, on compl\u00e8te le fichier de configuration <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml<\/b><\/span><span style=\"font-weight: 400; color: #000000;\"> et le module <\/span><span style=\"color: #6e4bec;\"><b>people.py<\/b><\/span><span style=\"font-weight: 400; color: #000000;\"> afin de satisfaire aux sp\u00e9cifications de notre API.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Les fichiers compl\u00e9t\u00e9s sont accessibles dans le sous-r\u00e9pertoire<\/span><span style=\"color: #6e4bec;\"><b> version_3<\/b><\/span><span style=\"font-weight: 400;\"> sous GitHub : <\/span><\/span><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"https:\/\/github.com\/salimlardjane1\/projects\/tree\/version_3\"><span style=\"font-weight: 400;\">https:\/\/github.com\/salimlardjane1\/projects\/tree\/version_3<\/span><\/a><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">L\u2019ex\u00e9cution de <\/span><span style=\"color: #6e4bec;\"><b>server.py<\/b><\/span><span style=\"font-weight: 400;\"> donne alors, pour ce qui est de l\u2019interface Swagger\/OpenAPI :<\/span><\/span><\/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-279f5a1 elementor-widget elementor-widget-image\" data-id=\"279f5a1\" 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\/04\/unnamed-7.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-a5e0061 elementor-widget elementor-widget-text-editor\" data-id=\"a5e0061\" 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><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">L\u2019interface pr\u00e9c\u00e9dente permet d\u2019acc\u00e9der \u00e0 la documentation renseign\u00e9e dans le fichier <\/span><span style=\"color: #6e4bec;\"><b>swagger.yml<\/b><\/span><span style=\"font-weight: 400;\"> et d\u2019interagir avec toutes les URL impl\u00e9mentant les fonctionnalit\u00e9s CRUD de l\u2019API.<\/span><\/span><\/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-0af81bd elementor-widget elementor-widget-menu-anchor\" data-id=\"0af81bd\" 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-b86c2bb elementor-widget elementor-widget-heading\" data-id=\"b86c2bb\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">7. Application Web<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-57dc09a elementor-widget elementor-widget-text-editor\" data-id=\"57dc09a\" 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><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">On dispose \u00e0 pr\u00e9sent d\u2019une <\/span><span style=\"color: #6e4bec;\"><b>API REST<\/b><\/span><span style=\"font-weight: 400;\"> document\u00e9e et avec laquelle on peut interagir \u00e0 l\u2019aide de Swagger\/OpenAPI.<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Comment aller plus loin ?<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">L\u2019\u00e9tape suivante consiste \u00e0 cr\u00e9er une <\/span><span style=\"color: #6e4bec;\"><b>application Web<\/b><\/span><span style=\"font-weight: 400;\"> illustrant l\u2019utilisation concr\u00e8te de l\u2019API.<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">On cr\u00e9e une application Web qui affiche les personnes de la base \u00e0 l\u2019\u00e9cran et permet d\u2019ajouter des personnes, de mettre \u00e0 jour les donn\u00e9es des personnes et de supprimer des personnes de la base. Cela sera fait \u00e0 l\u2019aide de requ\u00eates AJAX \u00e9mises de JavaScript vers les URL de notre API.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Pour commencer, on doit compl\u00e9ter le fichier <\/span><span style=\"color: #6e4bec;\"><b>home.html<\/b><\/span><span style=\"font-weight: 400;\">, qui contr\u00f4le la structure et l\u2019apparence de la page d\u2019accueil de l\u2019application web, de la fa\u00e7on suivante :<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Le fichier <\/span><b><span style=\"color: #6e4bec;\">home.html<\/span> <\/b><span style=\"font-weight: 400;\">est disponible <span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"https:\/\/github.com\/salimlardjane1\/projects\/tree\/version_4\">sur GitHub<\/a><\/span> :<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Dans le sous-r\u00e9pertoire <\/span><span style=\"color: #6e4bec;\"><b>templates<\/b><\/span><span style=\"font-weight: 400;\"> du r\u00e9pertoire <\/span><span style=\"color: #6e4bec;\"><b>version_4<\/b><span style=\"font-weight: 400;\">.<\/span><\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Le programme HTML compl\u00e8te le programme <\/span><span style=\"color: #6e4bec;\"><b>home.html<\/b><\/span><span style=\"font-weight: 400;\"> initial en y adjoignant un appel au fichier externe <\/span><span style=\"color: #6e4bec;\"><b>normalize.min.css<\/b><\/span><span style=\"font-weight: 400;\"> (https:\/\/ necolas.github.io\/normalize.css\/), qui permet de normaliser l\u2019affichage sur diff\u00e9rents navigateurs.<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Il fait \u00e9galement appel au fichier <\/span><span style=\"color: #6e4bec;\"><b>jquery-3.3.1.min.js<\/b><\/span><span style=\"font-weight: 400;\"> (https:\/\/ jquery.com) qui permet de disposer des fonctionnalit\u00e9s jQuery en JavaScript. Celles-ci sont utilis\u00e9es pour programmer l\u2019interactivit\u00e9 de la page.<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Le code HTML d\u00e9finit la partie statique de l\u2019application. Les parties dynamiques seront apport\u00e9es par JavaScript lors de l\u2019acc\u00e8s \u00e0 la page et lorsque l\u2019utilisateur interagit avec celle-ci.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Le fichier <\/span><span style=\"color: #6e4bec;\"><b>home.html<\/b><\/span><span style=\"font-weight: 400;\"> fait r\u00e9f\u00e9rence \u00e0 deux fichiers statiques : <\/span><span style=\"color: #6e4bec;\"><b>static\/css\/home.css<\/b><\/span><span style=\"font-weight: 400;\"> et <\/span><span style=\"color: #6e4bec;\"><b>static\/js\/home.js<\/b><\/span><span style=\"font-weight: 400;\"><span style=\"color: #6e4bec;\">. <\/span>Le r\u00e9pertoire nomm\u00e9 <\/span><span style=\"color: #6e4bec;\"><b>static <\/b><\/span><span style=\"font-weight: 400;\">est imm\u00e9diatement reconnu par l\u2019application Flask et le contenu des r\u00e9pertoires <\/span><span style=\"color: #6e4bec;\"><b>css<\/b><\/span><span style=\"font-weight: 400;\"> et <\/span><span style=\"color: #6e4bec;\"><b>js<\/b><\/span><span style=\"font-weight: 400;\"> est ainsi accessible \u00e0 partir du fichier <\/span><span style=\"color: #6e4bec;\"><b>home.html<\/b><span style=\"font-weight: 400;\">.<\/span><\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Les fichiers <\/span><span style=\"color: #6e4bec;\"><b>home.css<\/b><\/span><span style=\"font-weight: 400;\"> et <\/span><span style=\"color: #6e4bec;\"><b>home.js<\/b><\/span><span style=\"font-weight: 400;\"> sont <span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"https:\/\/github.com\/salimlardjane1\/projects\/tree\/version_4\">disponibles sur GitHub :<\/a><\/span><\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">On parlera davantage de CSS et de JavaScript dans le prochain article.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Lorsqu\u2019on se place dans le r\u00e9pertoire <\/span><span style=\"color: #6e4bec;\"><b>version_4<\/b><\/span><span style=\"font-weight: 400;\"> et qu\u2019on ex\u00e9cute <\/span><span style=\"color: #6e4bec;\"><b>server.py<\/b><\/span><span style=\"font-weight: 400;\">, on obtient le r\u00e9sultat suivant dans le navigateur :<\/span><\/span><\/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-309de56 elementor-widget elementor-widget-image\" data-id=\"309de56\" 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\/04\/unnamed-8.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-dc50201 elementor-widget elementor-widget-text-editor\" data-id=\"dc50201\" 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><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Le bouton <\/span><span style=\"color: #6e4bec;\"><b>Cr\u00e9er<\/b><\/span><span style=\"font-weight: 400;\"> permet \u00e0 l\u2019utilisateur de rajouter une personne au catalogue sur le serveur.<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">Un double clic sur une ligne du tableau fait appara\u00eetre le nom et le pr\u00e9nom dans les champs de saisie.<\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Pour <\/span><span style=\"color: #6e4bec;\"><b>mettre \u00e0 jour<\/b><\/span><span style=\"font-weight: 400;\">, l\u2019utilisateur doit modifier le pr\u00e9nom, le nom \u00e9tant la clef de recherche.<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"font-weight: 400;\">Pour <\/span><span style=\"color: #6e4bec;\"><b>supprimer<\/b><\/span><span style=\"font-weight: 400;\"> une personne de l\u2019annuaire, il suffit de cliquer sur <\/span><span style=\"color: #6e4bec;\"><b>Supprimer<\/b><\/span><span style=\"font-weight: 400;\">.<\/span><\/span><\/p><p><span style=\"color: #000000;\"><span style=\"color: #6e4bec;\"><b>R\u00e9initialiser<\/b><\/span><span style=\"font-weight: 400;\"> vide les champs de saisie.<\/span><\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">On a ainsi construit une petite application Web fonctionnelle.<\/span><\/p><p><span style=\"font-weight: 400; color: #000000;\">On verra plus en d\u00e9tail son fonctionnement dans le prochain article.<\/span><\/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-619791b elementor-widget elementor-widget-menu-anchor\" data-id=\"619791b\" 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=\"API8\" 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-ae55f3a elementor-widget elementor-widget-heading\" data-id=\"ae55f3a\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">8. R\u00e9f\u00e9rences bibliographiques<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-97dd94a elementor-widget elementor-widget-text-editor\" data-id=\"97dd94a\" 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 style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"color: #000000;\"><i><span style=\"font-weight: 400;\">Creating Web APIs with Python and Flask, <\/span><\/i><span style=\"font-weight: 400;\">Patrick Smyth, 2022 :<\/span><\/span><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"https:\/\/programminghistorian.org\/en\/lessons\/creating-apis-with-python-and-flask\"><span style=\"font-weight: 400;\"> https:\/\/programminghistorian.org\/en\/lessons\/creating-apis-with-python-and-flask<\/span><\/a><\/span><span style=\"font-weight: 400;\">.<\/span><\/li><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"color: #000000;\"><i><span style=\"font-weight: 400;\">Python REST APIs With Flask, Connexion, and SQLAlchemy<\/span><\/i><span style=\"font-weight: 400;\">, Doug Farrell, 2022 :\u00a0 <\/span><\/span><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"https:\/\/realpython.com\/flask-connexion-rest-api\/\"><span style=\"font-weight: 400;\">https:\/\/realpython.com\/flask-connexion-rest-api\/<\/span><\/a><\/span><span style=\"font-weight: 400;\">.\u00a0\u00a0<\/span><\/li><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"color: #000000;\"><i><span style=\"font-weight: 400;\">Python REST APIs With Flask, Connexion, and SQLAlchemy<\/span><\/i><span style=\"font-weight: 400;\">, Doug Farrell, 2022 : <\/span><\/span><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"https:\/\/realpython.com\/flask-connexion-rest-api-part-2\/\"><span style=\"font-weight: 400;\">https:\/\/realpython.com\/flask-connexion-rest-api-part-2\/<\/span><\/a><\/span><span style=\"font-weight: 400;\">.<\/span><\/li><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"color: #000000;\"><i><span style=\"font-weight: 400;\">Flask RESTful documentation<\/span><\/i><span style=\"font-weight: 400;\">, 2020 :<\/span><\/span><span style=\"color: #5e36f3;\"><a style=\"color: #5e36f3;\" href=\"https:\/\/flask-restful.readthedocs.io\/en\/latest\/index.html\"><span style=\"font-weight: 400;\"> https:\/\/flask-restful.readthedocs.io\/en\/latest\/index.html<\/span><\/a><\/span><span style=\"font-weight: 400;\">.<\/span><\/li><li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"color: #000000;\"><i><span style=\"font-weight: 400;\">Flask Web Development : Developing Web Applications with Python<\/span><\/i><span style=\"font-weight: 400;\"> (2\u00e8me \u00e9dition). M. Grinberg. O\u2019Reilly 2018.<\/span><\/span><\/li><li style=\"font-weight: 400;\" aria-level=\"1\"><i style=\"color: #000000;\"><span>Architectural Styles and the Design of Network-Based Software Architectures<\/span><\/i><span style=\"font-weight: 400;\">. T. Fielding. Th\u00e8se, Universit\u00e9 de Californie, 2000.<\/span><\/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<\/div>\n\t\t\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>On a vu dans les deux pr\u00e9c\u00e9dents articles un premier exemple de programmation d\u2019une API Web sous Flask et comment connecter une API Web \u00e0 une base de donn\u00e9e SqLite.&nbsp; On va voir dans la suite comment construire des API REST avec validation des inputs et des outputs et documentation automatiquement ge\u0301ne\u0301re\u0301e par Swagger\/OpenAPI. On [&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>Programmer et documenter une API<\/title>\n<meta name=\"description\" content=\"Dans cet article, nous allons voire comment construire des API REST avec validation des inputs et des outputs et documentation automatiquement ge\u0301ne\u0301re\u0301e par Swagger\/OpenAPI.\" \/>\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\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Programmer et documenter une API avec Python, Flask, Swagger et Connexion\" \/>\n<meta property=\"og:url\" content=\"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion\" \/>\n<meta property=\"og:site_name\" content=\"Formation Data Science | DataScientest.com\" \/>\n<meta property=\"article:published_time\" content=\"2022-04-12T16:09:07+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-09-26T13:07:18+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=\"13 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion\",\"url\":\"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion\",\"name\":\"Programmer et documenter une API\",\"isPartOf\":{\"@id\":\"https:\/\/datascientest.com\/#website\"},\"datePublished\":\"2022-04-12T16:09:07+00:00\",\"dateModified\":\"2024-09-26T13:07:18+00:00\",\"author\":{\"@id\":\"https:\/\/datascientest.com\/#\/schema\/person\/117e8a03bd4dcdb2740a26887f660ff3\"},\"description\":\"Dans cet article, nous allons voire comment construire des API REST avec validation des inputs et des outputs et documentation automatiquement ge\u0301ne\u0301re\u0301e par Swagger\/OpenAPI.\",\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion\"]}]},{\"@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":"Programmer et documenter une API","description":"Dans cet article, nous allons voire comment construire des API REST avec validation des inputs et des outputs et documentation automatiquement ge\u0301ne\u0301re\u0301e par Swagger\/OpenAPI.","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\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion","og_locale":"fr_FR","og_type":"article","og_title":"Programmer et documenter une API avec Python, Flask, Swagger et Connexion","og_url":"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion","og_site_name":"Formation Data Science | DataScientest.com","article_published_time":"2022-04-12T16:09:07+00:00","article_modified_time":"2024-09-26T13:07:18+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":"13 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion","url":"https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion","name":"Programmer et documenter une API","isPartOf":{"@id":"https:\/\/datascientest.com\/#website"},"datePublished":"2022-04-12T16:09:07+00:00","dateModified":"2024-09-26T13:07:18+00:00","author":{"@id":"https:\/\/datascientest.com\/#\/schema\/person\/117e8a03bd4dcdb2740a26887f660ff3"},"description":"Dans cet article, nous allons voire comment construire des API REST avec validation des inputs et des outputs et documentation automatiquement ge\u0301ne\u0301re\u0301e par Swagger\/OpenAPI.","inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/datascientest.com\/programmer-et-documenter-une-api-avec-python-flask-swagger-et-connexion"]}]},{"@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\/162993"}],"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=162993"}],"version-history":[{"count":0,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/posts\/162993\/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=162993"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/categories?post=162993"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/datascientest.com\/wp-json\/wp\/v2\/tags?post=162993"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}