‫Narrateur : Ainsi, notre API est maintenant pratiquement terminée.
‫Et donc dans cette dernière
‫vidéo de la section, nous allons rapidement
‫créer une documentation pour l'API directement dans Postman.
‫Et c'est vrai, nous pouvons
‫facilement créer une documentation rapide directement dans Postman.
‫Et il est vraiment important d'avoir une documentation
‫API en place car c'est ainsi que nous communiquons aux membres de
‫l'équipe, ou même à nos utilisateurs finaux de l'API, comment
‫ils peuvent l'utiliser dans la pratique.
‫Alors laissez-moi maintenant vous montrer comment cela fonctionne.
‫Maintenant, avant de pouvoir créer la documentation,
‫faisons un peu de nettoyage ici.
‫Par exemple, débarrassez-vous de cette requête, d'accord ?
‫Une autre chose que je veux faire est ici au point de
‫connexion, nous exposons en fait notre mot de passe ici.
‫Et donc ce n'est pas une bonne idée, et donc ce que
‫je vais faire est de créer une variable d'environnement
‫qui va contenir ce mot de passe.
‫Comme c'est toujours la même chose, cela ne devrait poser aucun problème.
‫Alors, rappelez-vous comment nous faisons cela.
‫Eh bien, nous arrivons ici à la gestion de
‫l'environnement et donc ici, nous en ajoutons simplement un autre.
‫Donc mot de passe, test1234.
‫Et ici, ce n'est pas correct, donc mot de passe, mis à jour, et maintenant,
‫faisons de même ici dans
‫celui de production.
‫Donc mot de passe, test1234.
‫Et donc, n'ajoutez pas, mais terminons cela et donc
‫ici, je peux maintenant ajouter et utiliser cela, pas
‫dans une chaîne, mais comme ça.
‫Donc mot de passe.
‫Alors essayons ça.
‫Et cela nous donne cette erreur étrange, mais notre mot
‫de passe est en fait ici, donc probablement
‫ce que nous devons faire est de vraiment mettre les guillemets ici.
‫Alors essayons ça.
‫Et maintenant, en effet, nous sommes connectés avec succès.
‫Alors garde ça maintenant, d'accord ?
‫Et maintenant, ce que nous devons faire, c'est créer
‫une description pour chaque demande que nous
‫avons dans notre collection.
‫Maintenant, bien sûr, je ne vais
‫pas le faire, je vais juste l'illustrer ici avec le premier.
‫D'accord?
‫Alors fermons en fait ces
‫autres et maintenant, ici, nous pouvons ajouter une description.
‫Et disons simplement, utilisez ce point de
‫terminaison pour créer une nouvelle visite.
‫D'accord, et encore une fois, vous devriez maintenant faire exactement la même chose
‫pour toutes vos demandes si votre objectif est vraiment de publier
‫et de partager votre API, d'accord ?
‫Ensuite, la même chose s'applique aux dossiers, et
‫non pas à renommer, mais à éditer.
‫Et donc dans chacun
‫de ces dossiers, nous pouvons également ajouter une description.
‫Disons simplement, quelque chose d'aléatoire comme, vous pouvez
‫obtenir toutes les visites, en créer de
‫nouvelles, et
‫modifier et supprimer des visites.
‫Il existe également des points de terminaison spéciaux pour
‫certaines exigences particulières.
‫D'accord, encore et encore, c'est totalement aléatoire
‫et je publierais quelque chose comme ça pour ma propre API,
‫mais ici, nous voulons juste tester comment cela fonctionne, d'accord ?
‫Comme vous pouvez le
‫voir ici, vous pouvez également utiliser Mark ici, d'accord ?
‫Ainsi, par exemple, pour mettre du texte en
‫gras, vous pouvez penser que cela fonctionne comme ceci, ouais on
‫dirait que c'est le cas, et
‫donc oui, vous pouvez faire toutes sortes de choses ici, d'accord ?
‫Vous pouvez également probablement
‫créer une description sur Natours
‫lui-même, alors disons que l'API Natours contient des points
‫de terminaison pour les visites, les utilisateurs et les avis.
‫Et puis encore un
‫tas de choses, comme vous pourriez décrire votre processus
‫d'authentification, ou vos autorisations et vraiment tout ce que
‫l'utilisateur a besoin de savoir pour utiliser cette API, d'accord ?
‫Vous devez donc toujours
‫ajouter une description à toutes les demandes, à tous les
‫dossiers et aussi, bien sûr, à la collection elle-même.
‫Oh, et nous pouvons en fait décrire les paramètres de requête dans
‫une chaîne de requête, alors faisons-le ici.
‫Et nous pouvons également dire qu'il prend en charge
‫les opérateurs supérieur à, inférieur à égal, supérieur à et inférieur à.
‫Encore une fois, juste un
‫exemple ici et enregistrons-le maintenant dans la requête.
‫Et donc avec cela, je pense
‫que nous devrions être prêts à publier notre documentation API.
‫Et donc pour ce faire, allons
‫simplement ici dans l'option collections, puis ici,
‫publions les documentations.
‫Et donc cela devrait ensuite ouvrir une fenêtre de navigateur, et
‫pour moi, cela s'est produit en dehors
‫de mon écran, alors laissez-moi simplement l'obtenir ici.
‫Et maintenant, vous pouvez choisir l'environnement.
‫Donc ici, nous devrions avoir une liste de nos environnements, que
‫pour une raison quelconque nous n'avons pas, c'est bizarre, mais de toute façon,
‫nous ne voulions pas utiliser d'environnement de toute façon, car cela
‫remplacerait alors nos variables
‫d'environnement par leurs valeurs réelles, et nous ne voulons
‫pas de cela.
‫Par exemple, nous avons utilisé la variable d'environnement
‫sur le mot de passe, de sorte
‫que plus tard dans la documentation, ce n'est pas vraiment visible, d'accord ?
‫Nous voulons donc vraiment n'utiliser aucun environnement.
‫Maintenant, nous pourrions également utiliser
‫un domaine personnalisé, mais ce n'est que pour les utilisateurs payants, d'accord ?
‫Ensuite, nous pourrions également modifier tout le style
‫de l'API afin de l'adapter aux couleurs de votre marque,
‫mais encore une fois, ce n'est pas
‫nécessaire dans ce cas, et donc, allons-y et publions-le.
‫Et maintenant, c'est en fait public,
‫donc tout le monde peut voir votre documentation maintenant sur cette URL.
‫Maintenant, pour une raison quelconque, il n'a pas vraiment mis à jour tous les
‫changements que nous venons de faire avant, donc c'est un peu bizarre.
‫Revenons donc à Postman et voyons ce
‫qui se passe.
‫Peut-être que cela a à voir avec cette chose en rotation ici, donc je
‫vais juste quitter Postman et l'ouvrir à nouveau.
‫Et espérons que cela le résout.
‫Donc, si nous rechargeons maintenant
‫ici, ahh alors nous obtenons tous nos changements ici.
‫Alors vous voyez, la description que
‫nous avons ajoutée pour la collection Natours, d'accord ?
‫Puis aussi la description de ce dossier, et
‫la description de cette requête.
‫Et enfin, comme première
‫description, également pour ce paramètre, d'accord ?
‫Ici, nous obtenons ensuite la variable d'environnement URL au
‫lieu de l'URL réelle.
‫Maintenant, bien sûr, vous voudrez peut-être donner la
‫véritable URL ici et pour cela,
‫vous pouvez simplement utiliser un autre environnement.
‫Donc ici, vous pouvez voir tous les environnements
‫mais ils sont privés, donc pour le moment personne ne peut les
‫utiliser, mais rappelez-vous comment
‫dans la première étape, nous aurions pu
‫créer cette documentation en utilisant l'un des environnements, et donc
‫probablement nous le ferions avons utilisé l'environnement de production
‫pour cela et avec cela, nous aurions alors l'URL de
‫production finale ici dans nos URL d'API, d'accord ?
‫Quoi qu'il en soit, voici à
‫quoi ressemble la documentation, voici donc l'exemple de demande et
‫nous pouvons également le modifier dans notre propre langue.
‫Donc, dans ce cas, Node JS,
‫mais si l'utilisateur fait par exemple une requête
‫en utilisant jQuery, alors il peut simplement utiliser jQuery, d'accord.
‫Donc juste pour voir cet exemple de requête ici, donc avec Node, ça
‫ressemble à ça.
‫Donc, ici, nous avons tous nos points
‫de terminaison et vous pouvez voir que ceux qui nécessitent une
‫authentification, ils ont en fait cette icône de verrouillage ici.
‫Et donc, dans votre description, vous pouvez maintenant
‫ajouter que vous devez vous connecter pour accéder à ce point de
‫terminaison, et aussi comment vous pouvez réellement vous connecter, d'accord.
‫Ou vous pouvez également
‫le décrire ici dans la section authentification, n'est-ce pas ?
‫Donc idéalement, vous auriez des descriptions pour tout cela.
‫Oh, et là, je
‫vois que nous avons en fait oublié de remplacer le vrai mot
‫de passe, mais peu importe car ce n'est vraiment qu'un exemple, d'accord ?
‫Mais bien sûr, vous obtenez également ici
‫toutes les demandes que nous avons eues dans notre facteur.
‫Maintenant, une autre fonctionnalité intéressante ici est ce bouton Exécuter dans Postman,
‫et donc si quelqu'un a installé Postman sur son
‫ordinateur, tout ce qu'il a à
‫faire est de cliquer ici, puis d'ouvrir avec son application Postman.
‫Maintenant, je ne vais pas le faire pour
‫le moment car bien sûr, je l'ai déjà dans mon Postman, mais sinon,
‫c'est une fonctionnalité très intéressante pour les utilisateurs qui peuvent ensuite aller de
‫l'avant et commencer tout de suite à expérimenter avec votre API.
‫D'accord, et je pense que c'est tout, donc
‫cela conclut notre section
‫et notre API est enfin vraiment terminée.
‫Donc encore une fois, félicitations pour être arrivé si loin
‫dans le cours, nous avons
‫déjà parcouru tellement de terrain ici ensemble.
‫Ensuite, il y a une section très, très excitante à
‫venir où nous allons enfin créer
‫le visage utilisateur pour le site Web de Natours.
‫Donc, en gros, nous allons utiliser des
‫modèles pour créer un site Web complètement dynamique basé sur toutes les
‫données que nous avons déjà dans notre base de données.
‫Et c'est vraiment cool.
‫Et donc j'ai hâte de vous le montrer.