Pourquoi et quand exécuter cette tâche L'interface utilisateur Swagger est une infrastructure d'affichage qui peut analyser la spécification
Swagger est un langage de description d'interface permettant de décrire des API exprimées à l'aide de JSON. Swagger est utilisé avec toute une série d'outils logiciels open source pour concevoir, créer, documenter et utiliser des services Web.
Pour accéder à Swaggervous devez appuyer sur le bouton Preview dans l'application publiée et cliquer sur le nom du plan de publication souhaité (Deploy Plan).
Si vous naviguez vers http://localhost:3001/swagger, vous verrez la page de documentation générée à partir de votre code. Cliquez maintenant sur le bouton Try it out. Les champs deviennent éditables et vous pouvez envoyer des requêtes pour tester votre API.
Les API servent à intégrer de nouvelles applications aux systèmes logiciels existants. Cela permet d'accélérer le développement, étant donné que chaque fonctionnalité ne doit pas être écrite en ne partant de rien. Vous pouvez utiliser les API pour tirer parti du code existant.
Pour installer Swagger UI, il suffit de le télécharger depuis GitHub. Ensuite, nous allons le décompresser dans un dossier nommé swagger-ui dans le répertoire web. Nous utiliserons la version v2.
Dans une pratique très concrète, tester une API, techniquement et fonctionnellement, passe par un outil spécifique : un outil de documentation d'API digne de ce nom. Cet outil permet de « documenter », ou encore mieux de « spécifier » une API à travers ses différents points d'API (endpoints).
Qu'est-ce que Swagger ? Swagger est un outil open-source qui permet de développer des API, d'interagir avec des API et, principalement, de générer de la documentation pour les API.
Une API (application programming interface ou « interface de programmation d'application ») est une interface logicielle qui permet de « connecter » un logiciel ou un service à un autre logiciel ou service afin d'échanger des données et des fonctionnalités.
Pour tester notre API nous pouvons dans un premier temps utiliser l'extension Postman de Chrome ou l'extension RESTClient pour Firefox. Si on veut une solution en ligne de commande, curl permet de manipuler les différentes méthodes HTTP. La syntaxe n'est pas idéale mais on peut tester toutes les méthodes HTTP.
GET est le verbe HTTP pour obtenir des données, et il est généralement utilisé avec un ID pour obtenir une donnée spécifique. Les applications utilisent GET pour présenter des informations sur des pages web.
Vous pouvez héberger vos API sur Azure App Service, une offre PaaS (platform as a service) qui propose un hébergement d'API simple et hautement évolutif.
Dans cet exemple, l'API Payload représente un objet JSON contenant des informations utilisateur. Si une application client doit envoyer ces données à une application serveur pour créer un nouvel utilisateur, elle inclura l'objet JSON dans la charge utile de la requête.
Important : Il est conseillé d'utiliser le protocole SSL (ou https) lors du déploiement des services Web afin de protéger les échanges d'authentification au niveau de l'application ainsi que les transmissions ultérieures d'identification et de données de session.
Swagger est une spécification ouverte pour la définition d'API REST. L'interface utilisateur Swagger est une infrastructure d'affichage qui peut analyser la spécification OpenAPI et générer une console d'API interactive permettant aux utilisateurs d'apprendre rapidement et facilement et d'exécuter les API REST.
L'API REST est évolutive
C'est pourquoi ce type d'API est la méthode d'intégration la plus utilisée et la plus efficace.
On parle par exemple d'APIs de type JSON/Rest. Une API définit exactement les méthodes d'interaction d'un logiciel avec l'autre. Lorsque cette action implique l'envoi de données sur un réseau, les services Web entrent en ligne de compte.
REST. L'architecture REST (representational state transfer) est peut-être l'approche la plus populaire pour construire des API.
Un microservice contient tout le code requis pour une fonction d'application spécifique. Une API est un mécanisme de communication permettant d'accéder à cette fonction.
SOAP ne prend en charge que l'échange de données XML. REST prend en charge les formats XML, JSON, texte brut et HTML. Les messages SOAP sont plus volumineux, ce qui ralentit la communication. REST offre des performances plus rapides grâce à la réduction du nombre de messages et à la prise en charge de la mise en cache.
Les API permettent de communiquer des données. Elles permettent la communication entre différents composants de votre application et entre votre application et d'autres développeurs, par l'utilisation de requêtes et de réponses. Elles donnent un moyen d'accès aux données de façon réutilisable et standardisée.