1 00:00:01,100 --> 00:00:04,510 ‫Narrateur : Ainsi, notre API est maintenant pratiquement terminée. 2 00:00:04,510 --> 00:00:07,003 ‫Et donc dans cette dernière 3 00:00:07,003 --> 00:00:09,680 ‫vidéo de la section, nous allons rapidement 4 00:00:09,680 --> 00:00:13,020 ‫créer une documentation pour l'API directement dans Postman. 5 00:00:13,020 --> 00:00:15,290 ‫Et c'est vrai, nous pouvons 6 00:00:15,290 --> 00:00:18,830 ‫facilement créer une documentation rapide directement dans Postman. 7 00:00:18,830 --> 00:00:21,620 ‫Et il est vraiment important d'avoir une documentation 8 00:00:21,620 --> 00:00:25,870 ‫API en place car c'est ainsi que nous communiquons aux membres de 9 00:00:25,870 --> 00:00:29,140 ‫l'équipe, ou même à nos utilisateurs finaux de l'API, comment 10 00:00:29,140 --> 00:00:31,740 ‫ils peuvent l'utiliser dans la pratique. 11 00:00:31,740 --> 00:00:33,973 ‫Alors laissez-moi maintenant vous montrer comment cela fonctionne. 12 00:00:35,490 --> 00:00:38,367 ‫Maintenant, avant de pouvoir créer la documentation, 13 00:00:38,367 --> 00:00:40,920 ‫faisons un peu de nettoyage ici. 14 00:00:40,920 --> 00:00:45,010 ‫Par exemple, débarrassez-vous de cette requête, d'accord ? 15 00:00:47,550 --> 00:00:51,490 ‫Une autre chose que je veux faire est ici au point de 16 00:00:51,490 --> 00:00:55,180 ‫connexion, nous exposons en fait notre mot de passe ici. 17 00:00:55,180 --> 00:00:58,220 ‫Et donc ce n'est pas une bonne idée, et donc ce que 18 00:00:58,220 --> 00:01:00,350 ‫je vais faire est de créer une variable d'environnement 19 00:01:00,350 --> 00:01:02,320 ‫qui va contenir ce mot de passe. 20 00:01:02,320 --> 00:01:06,100 ‫Comme c'est toujours la même chose, cela ne devrait poser aucun problème. 21 00:01:06,100 --> 00:01:07,833 ‫Alors, rappelez-vous comment nous faisons cela. 22 00:01:09,920 --> 00:01:12,730 ‫Eh bien, nous arrivons ici à la gestion de 23 00:01:13,970 --> 00:01:16,903 ‫l'environnement et donc ici, nous en ajoutons simplement un autre. 24 00:01:17,960 --> 00:01:19,807 ‫Donc mot de passe, test1234. 25 00:01:23,820 --> 00:01:28,820 ‫Et ici, ce n'est pas correct, donc mot de passe, mis à jour, et maintenant, 26 00:01:30,220 --> 00:01:31,860 ‫faisons de même ici dans 27 00:01:31,860 --> 00:01:33,363 ‫celui de production. 28 00:01:35,440 --> 00:01:37,297 ‫Donc mot de passe, test1234. 29 00:01:41,020 --> 00:01:46,020 ‫Et donc, n'ajoutez pas, mais terminons cela et donc 30 00:01:46,590 --> 00:01:51,120 ‫ici, je peux maintenant ajouter et utiliser cela, pas 31 00:01:51,120 --> 00:01:55,003 ‫dans une chaîne, mais comme ça. 32 00:01:56,840 --> 00:01:58,490 ‫Donc mot de passe. 33 00:01:58,490 --> 00:01:59,633 ‫Alors essayons ça. 34 00:02:00,980 --> 00:02:04,620 ‫Et cela nous donne cette erreur étrange, mais notre mot 35 00:02:04,620 --> 00:02:07,840 ‫de passe est en fait ici, donc probablement 36 00:02:07,840 --> 00:02:12,313 ‫ce que nous devons faire est de vraiment mettre les guillemets ici. 37 00:02:13,360 --> 00:02:14,680 ‫Alors essayons ça. 38 00:02:14,680 --> 00:02:17,740 ‫Et maintenant, en effet, nous sommes connectés avec succès. 39 00:02:17,740 --> 00:02:21,090 ‫Alors garde ça maintenant, d'accord ? 40 00:02:21,090 --> 00:02:23,990 ‫Et maintenant, ce que nous devons faire, c'est créer 41 00:02:23,990 --> 00:02:26,290 ‫une description pour chaque demande que nous 42 00:02:26,290 --> 00:02:28,150 ‫avons dans notre collection. 43 00:02:28,150 --> 00:02:30,120 ‫Maintenant, bien sûr, je ne vais 44 00:02:30,120 --> 00:02:33,173 ‫pas le faire, je vais juste l'illustrer ici avec le premier. 45 00:02:34,270 --> 00:02:35,103 ‫D'accord? 46 00:02:36,630 --> 00:02:39,250 ‫Alors fermons en fait ces 47 00:02:39,250 --> 00:02:42,840 ‫autres et maintenant, ici, nous pouvons ajouter une description. 48 00:02:42,840 --> 00:02:46,350 ‫Et disons simplement, utilisez ce point de 49 00:02:49,150 --> 00:02:52,403 ‫terminaison pour créer une nouvelle visite. 50 00:02:53,530 --> 00:02:58,514 ‫D'accord, et encore une fois, vous devriez maintenant faire exactement la même chose 51 00:02:58,514 --> 00:03:03,030 ‫pour toutes vos demandes si votre objectif est vraiment de publier 52 00:03:03,030 --> 00:03:06,170 ‫et de partager votre API, d'accord ? 53 00:03:06,170 --> 00:03:09,633 ‫Ensuite, la même chose s'applique aux dossiers, et 54 00:03:11,130 --> 00:03:14,300 ‫non pas à renommer, mais à éditer. 55 00:03:14,300 --> 00:03:15,900 ‫Et donc dans chacun 56 00:03:15,900 --> 00:03:18,870 ‫de ces dossiers, nous pouvons également ajouter une description. 57 00:03:18,870 --> 00:03:23,380 ‫Disons simplement, quelque chose d'aléatoire comme, vous pouvez 58 00:03:23,380 --> 00:03:27,093 ‫obtenir toutes les visites, en créer de 59 00:03:27,960 --> 00:03:29,463 ‫nouvelles, et 60 00:03:31,400 --> 00:03:34,743 ‫modifier et supprimer des visites. 61 00:03:36,580 --> 00:03:41,000 ‫Il existe également des points de terminaison spéciaux pour 62 00:03:42,630 --> 00:03:44,763 ‫certaines exigences particulières. 63 00:03:46,170 --> 00:03:48,680 ‫D'accord, encore et encore, c'est totalement aléatoire 64 00:03:48,680 --> 00:03:52,350 ‫et je publierais quelque chose comme ça pour ma propre API, 65 00:03:52,350 --> 00:03:56,100 ‫mais ici, nous voulons juste tester comment cela fonctionne, d'accord ? 66 00:03:56,100 --> 00:03:57,540 ‫Comme vous pouvez le 67 00:03:57,540 --> 00:04:00,800 ‫voir ici, vous pouvez également utiliser Mark ici, d'accord ? 68 00:04:00,800 --> 00:04:03,240 ‫Ainsi, par exemple, pour mettre du texte en 69 00:04:03,240 --> 00:04:06,273 ‫gras, vous pouvez penser que cela fonctionne comme ceci, ouais on 70 00:04:07,820 --> 00:04:09,920 ‫dirait que c'est le cas, et 71 00:04:09,920 --> 00:04:13,523 ‫donc oui, vous pouvez faire toutes sortes de choses ici, d'accord ? 72 00:04:15,970 --> 00:04:18,730 ‫Vous pouvez également probablement 73 00:04:18,730 --> 00:04:21,500 ‫créer une description sur Natours 74 00:04:21,500 --> 00:04:26,363 ‫lui-même, alors disons que l'API Natours contient des points 75 00:04:30,950 --> 00:04:35,950 ‫de terminaison pour les visites, les utilisateurs et les avis. 76 00:04:37,790 --> 00:04:39,510 ‫Et puis encore un 77 00:04:39,510 --> 00:04:42,500 ‫tas de choses, comme vous pourriez décrire votre processus 78 00:04:42,500 --> 00:04:45,320 ‫d'authentification, ou vos autorisations et vraiment tout ce que 79 00:04:45,320 --> 00:04:48,820 ‫l'utilisateur a besoin de savoir pour utiliser cette API, d'accord ? 80 00:04:48,820 --> 00:04:50,510 ‫Vous devez donc toujours 81 00:04:50,510 --> 00:04:54,060 ‫ajouter une description à toutes les demandes, à tous les 82 00:04:54,060 --> 00:04:57,490 ‫dossiers et aussi, bien sûr, à la collection elle-même. 83 00:04:57,490 --> 00:05:01,510 ‫Oh, et nous pouvons en fait décrire les paramètres de requête dans 84 00:05:01,510 --> 00:05:03,943 ‫une chaîne de requête, alors faisons-le ici. 85 00:05:09,634 --> 00:05:13,384 ‫Et nous pouvons également dire qu'il prend en charge 86 00:05:14,620 --> 00:05:19,620 ‫les opérateurs supérieur à, inférieur à égal, supérieur à et inférieur à. 87 00:05:23,070 --> 00:05:24,890 ‫Encore une fois, juste un 88 00:05:26,070 --> 00:05:28,490 ‫exemple ici et enregistrons-le maintenant dans la requête. 89 00:05:28,490 --> 00:05:30,580 ‫Et donc avec cela, je pense 90 00:05:30,580 --> 00:05:33,700 ‫que nous devrions être prêts à publier notre documentation API. 91 00:05:33,700 --> 00:05:36,750 ‫Et donc pour ce faire, allons 92 00:05:36,750 --> 00:05:39,910 ‫simplement ici dans l'option collections, puis ici, 93 00:05:39,910 --> 00:05:42,070 ‫publions les documentations. 94 00:05:42,070 --> 00:05:45,400 ‫Et donc cela devrait ensuite ouvrir une fenêtre de navigateur, et 95 00:05:45,400 --> 00:05:47,830 ‫pour moi, cela s'est produit en dehors 96 00:05:47,830 --> 00:05:50,570 ‫de mon écran, alors laissez-moi simplement l'obtenir ici. 97 00:05:50,570 --> 00:05:53,700 ‫Et maintenant, vous pouvez choisir l'environnement. 98 00:05:53,700 --> 00:05:57,200 ‫Donc ici, nous devrions avoir une liste de nos environnements, que 99 00:05:57,200 --> 00:06:01,470 ‫pour une raison quelconque nous n'avons pas, c'est bizarre, mais de toute façon, 100 00:06:01,470 --> 00:06:05,060 ‫nous ne voulions pas utiliser d'environnement de toute façon, car cela 101 00:06:05,060 --> 00:06:06,540 ‫remplacerait alors nos variables 102 00:06:06,540 --> 00:06:09,340 ‫d'environnement par leurs valeurs réelles, et nous ne voulons 103 00:06:09,340 --> 00:06:10,460 ‫pas de cela. 104 00:06:10,460 --> 00:06:12,620 ‫Par exemple, nous avons utilisé la variable d'environnement 105 00:06:12,620 --> 00:06:14,620 ‫sur le mot de passe, de sorte 106 00:06:14,620 --> 00:06:17,900 ‫que plus tard dans la documentation, ce n'est pas vraiment visible, d'accord ? 107 00:06:17,900 --> 00:06:20,313 ‫Nous voulons donc vraiment n'utiliser aucun environnement. 108 00:06:21,270 --> 00:06:23,280 ‫Maintenant, nous pourrions également utiliser 109 00:06:23,280 --> 00:06:27,610 ‫un domaine personnalisé, mais ce n'est que pour les utilisateurs payants, d'accord ? 110 00:06:27,610 --> 00:06:30,740 ‫Ensuite, nous pourrions également modifier tout le style 111 00:06:30,740 --> 00:06:34,410 ‫de l'API afin de l'adapter aux couleurs de votre marque, 112 00:06:34,410 --> 00:06:37,260 ‫mais encore une fois, ce n'est pas 113 00:06:37,260 --> 00:06:40,620 ‫nécessaire dans ce cas, et donc, allons-y et publions-le. 114 00:06:40,620 --> 00:06:42,550 ‫Et maintenant, c'est en fait public, 115 00:06:42,550 --> 00:06:46,367 ‫donc tout le monde peut voir votre documentation maintenant sur cette URL. 116 00:06:47,480 --> 00:06:51,300 ‫Maintenant, pour une raison quelconque, il n'a pas vraiment mis à jour tous les 117 00:06:51,300 --> 00:06:54,653 ‫changements que nous venons de faire avant, donc c'est un peu bizarre. 118 00:06:55,510 --> 00:06:58,420 ‫Revenons donc à Postman et voyons ce 119 00:06:58,420 --> 00:07:00,090 ‫qui se passe. 120 00:07:00,090 --> 00:07:04,510 ‫Peut-être que cela a à voir avec cette chose en rotation ici, donc je 121 00:07:04,510 --> 00:07:07,158 ‫vais juste quitter Postman et l'ouvrir à nouveau. 122 00:07:07,158 --> 00:07:09,393 ‫Et espérons que cela le résout. 123 00:07:12,610 --> 00:07:15,060 ‫Donc, si nous rechargeons maintenant 124 00:07:15,060 --> 00:07:18,720 ‫ici, ahh alors nous obtenons tous nos changements ici. 125 00:07:18,720 --> 00:07:20,980 ‫Alors vous voyez, la description que 126 00:07:20,980 --> 00:07:23,620 ‫nous avons ajoutée pour la collection Natours, d'accord ? 127 00:07:23,620 --> 00:07:26,830 ‫Puis aussi la description de ce dossier, et 128 00:07:26,830 --> 00:07:29,530 ‫la description de cette requête. 129 00:07:29,530 --> 00:07:32,180 ‫Et enfin, comme première 130 00:07:32,180 --> 00:07:35,400 ‫description, également pour ce paramètre, d'accord ? 131 00:07:35,400 --> 00:07:39,477 ‫Ici, nous obtenons ensuite la variable d'environnement URL au 132 00:07:39,477 --> 00:07:41,850 ‫lieu de l'URL réelle. 133 00:07:41,850 --> 00:07:44,310 ‫Maintenant, bien sûr, vous voudrez peut-être donner la 134 00:07:44,310 --> 00:07:46,320 ‫véritable URL ici et pour cela, 135 00:07:46,320 --> 00:07:48,443 ‫vous pouvez simplement utiliser un autre environnement. 136 00:07:50,150 --> 00:07:53,170 ‫Donc ici, vous pouvez voir tous les environnements 137 00:07:53,170 --> 00:07:57,060 ‫mais ils sont privés, donc pour le moment personne ne peut les 138 00:07:57,060 --> 00:07:58,720 ‫utiliser, mais rappelez-vous comment 139 00:07:58,720 --> 00:08:01,430 ‫dans la première étape, nous aurions pu 140 00:08:01,430 --> 00:08:04,760 ‫créer cette documentation en utilisant l'un des environnements, et donc 141 00:08:04,760 --> 00:08:07,990 ‫probablement nous le ferions avons utilisé l'environnement de production 142 00:08:07,990 --> 00:08:11,350 ‫pour cela et avec cela, nous aurions alors l'URL de 143 00:08:11,350 --> 00:08:14,543 ‫production finale ici dans nos URL d'API, d'accord ? 144 00:08:15,440 --> 00:08:18,064 ‫Quoi qu'il en soit, voici à 145 00:08:18,064 --> 00:08:21,530 ‫quoi ressemble la documentation, voici donc l'exemple de demande et 146 00:08:21,530 --> 00:08:24,940 ‫nous pouvons également le modifier dans notre propre langue. 147 00:08:24,940 --> 00:08:27,840 ‫Donc, dans ce cas, Node JS, 148 00:08:27,840 --> 00:08:31,020 ‫mais si l'utilisateur fait par exemple une requête 149 00:08:31,020 --> 00:08:34,770 ‫en utilisant jQuery, alors il peut simplement utiliser jQuery, d'accord. 150 00:08:34,770 --> 00:08:39,290 ‫Donc juste pour voir cet exemple de requête ici, donc avec Node, ça 151 00:08:39,290 --> 00:08:40,793 ‫ressemble à ça. 152 00:08:42,870 --> 00:08:45,213 ‫Donc, ici, nous avons tous nos points 153 00:08:45,213 --> 00:08:48,400 ‫de terminaison et vous pouvez voir que ceux qui nécessitent une 154 00:08:48,400 --> 00:08:51,400 ‫authentification, ils ont en fait cette icône de verrouillage ici. 155 00:08:51,400 --> 00:08:54,299 ‫Et donc, dans votre description, vous pouvez maintenant 156 00:08:54,299 --> 00:08:57,960 ‫ajouter que vous devez vous connecter pour accéder à ce point de 157 00:08:57,960 --> 00:09:01,060 ‫terminaison, et aussi comment vous pouvez réellement vous connecter, d'accord. 158 00:09:01,060 --> 00:09:02,760 ‫Ou vous pouvez également 159 00:09:02,760 --> 00:09:06,290 ‫le décrire ici dans la section authentification, n'est-ce pas ? 160 00:09:06,290 --> 00:09:09,243 ‫Donc idéalement, vous auriez des descriptions pour tout cela. 161 00:09:10,360 --> 00:09:11,948 ‫Oh, et là, je 162 00:09:11,948 --> 00:09:15,770 ‫vois que nous avons en fait oublié de remplacer le vrai mot 163 00:09:15,770 --> 00:09:19,940 ‫de passe, mais peu importe car ce n'est vraiment qu'un exemple, d'accord ? 164 00:09:19,940 --> 00:09:22,040 ‫Mais bien sûr, vous obtenez également ici 165 00:09:22,040 --> 00:09:24,933 ‫toutes les demandes que nous avons eues dans notre facteur. 166 00:09:26,900 --> 00:09:30,780 ‫Maintenant, une autre fonctionnalité intéressante ici est ce bouton Exécuter dans Postman, 167 00:09:30,780 --> 00:09:33,830 ‫et donc si quelqu'un a installé Postman sur son 168 00:09:33,830 --> 00:09:36,380 ‫ordinateur, tout ce qu'il a à 169 00:09:36,380 --> 00:09:40,000 ‫faire est de cliquer ici, puis d'ouvrir avec son application Postman. 170 00:09:40,000 --> 00:09:42,490 ‫Maintenant, je ne vais pas le faire pour 171 00:09:42,490 --> 00:09:45,830 ‫le moment car bien sûr, je l'ai déjà dans mon Postman, mais sinon, 172 00:09:45,830 --> 00:09:49,270 ‫c'est une fonctionnalité très intéressante pour les utilisateurs qui peuvent ensuite aller de 173 00:09:49,270 --> 00:09:52,253 ‫l'avant et commencer tout de suite à expérimenter avec votre API. 174 00:09:54,070 --> 00:09:57,370 ‫D'accord, et je pense que c'est tout, donc 175 00:09:57,370 --> 00:09:59,330 ‫cela conclut notre section 176 00:09:59,330 --> 00:10:02,610 ‫et notre API est enfin vraiment terminée. 177 00:10:02,610 --> 00:10:06,440 ‫Donc encore une fois, félicitations pour être arrivé si loin 178 00:10:06,440 --> 00:10:08,720 ‫dans le cours, nous avons 179 00:10:08,720 --> 00:10:11,140 ‫déjà parcouru tellement de terrain ici ensemble. 180 00:10:11,140 --> 00:10:14,230 ‫Ensuite, il y a une section très, très excitante à 181 00:10:14,230 --> 00:10:16,460 ‫venir où nous allons enfin créer 182 00:10:16,460 --> 00:10:19,260 ‫le visage utilisateur pour le site Web de Natours. 183 00:10:19,260 --> 00:10:21,510 ‫Donc, en gros, nous allons utiliser des 184 00:10:21,510 --> 00:10:24,770 ‫modèles pour créer un site Web complètement dynamique basé sur toutes les 185 00:10:24,770 --> 00:10:27,810 ‫données que nous avons déjà dans notre base de données. 186 00:10:27,810 --> 00:10:29,380 ‫Et c'est vraiment cool. 187 00:10:29,380 --> 00:10:32,053 ‫Et donc j'ai hâte de vous le montrer.