Tutoriel: Comment développer une API avec Node.js et Swagger

Tutorial: Primeira API com Node.js e Swagger

L’acronyme API signifie Application Programming Interface, en français, Application Programming Interface. Cela permet l’intégration de systèmes, présentant des avantages tels que la protection et la sécurité des données, l’optimisation des performances de la plate-forme, l’automatisation des processus, la facilité d’échange d’informations entre les systèmes avec différents langages de programmation.

Avec l’interface utilisateur Swagger, il est possible de créer facilement une interface qui vous permet d’interagir avec son API. Apprendre à utiliser.

L’interface utilisateur Swagger est un projet open source permettant de rendre visuellement la documentation d’une interface de programmation d’application définie avec la spécification OpenAPI (Swagger).

L’interface Swagger vous permet d’afficher et d’interagir avec les ressources de l’API, ce qui facilite la mise en œuvre du backend et la consommation côté client.

Comment utiliser Swagger dans une API dans Node.js

Pour cet exemple, nous allons considérer une calculatrice. La calculatrice doit recevoir deux nombres d’entrée et effectuer les opérations nécessaires.

Pour ce projet, nous allons commencer par créer un nouveau référentiel sur GitHub avec le nom calculatrice_swagger.

Tutoriel: Première API avec Node.js et Swagger

Ensuite, nous allons copier le lien du référentiel à importer dans Code Visual Studio.

Tutoriel: Première API avec Node.js et Swagger

Dans Visual Studio Code, importez le référentiel. Pour ce faire, utilisez simplement le raccourci CTRL + MAJ + P pour ouvrir la boîte de commande. Dans là, choisissez l’option Cloner plus tard Cloner depuis GitHub et indiquez l’URL du référentiel.

Vous devez ensuite indiquer l’emplacement du projet dans votre système de fichiers. Enfin, ils doivent également ajouter le projet à WorkPlace. Vous pouvez voir ici comment procéder.

Tutoriel: Première API avec Node.js et Swagger

Commençons…

En utilisant la ligne de commande, nous allons démarrer le projet avec la commande npm init. Ils doivent ensuite indiquer les paramètres demandés.

1619153286 68 Tutoriel Comment developper une API avec Nodejs et Swagger

Nous avons ensuite installé Express à l’aide de la commande. Express.js est un framework pour Node.js qui permet le développement d’applications Web de manière très simple. L’installation d’Express.js dans l’environnement de programmation doit être effectuée via NPM.

Ensuite, nous avons installé le swagger-ui

npm i swagger-ui-express -S

Après avoir installé les dépendances, créons le fichier index.js et y mettons le code suivant:

Ensuite, nous créons le fichier swagger.json. Pour cet exemple, nous allons définir uniquement pour l’opération SUM.

Enfin, exécutons notre projet à l’aide de la commande.

Ouvrez l’adresse http: // localhost: 8001 / api-docs / et vous devriez voir l’interface suivante.

1619153286 913 Tutoriel Comment developper une API avec Nodejs et Swagger

Pour tester si tout est opérationnel, cliquez sur Try Out, indiquez deux chiffres …

Tutoriel: Première API avec Node.js et Swagger

puis cliquez sur Exécuter. Le résultat doit apparaître dans le champ Corps de réponse.

1619153286 616 Tutoriel Comment developper une API avec Nodejs et Swagger

Comme vous l’avez vu, il n’est pas très difficile de documenter une API avec Swagger. Il est à noter qu’il est possible d’utiliser JSON ou YAML pour produire le fichier avec l’interface. Bons horaires.