Chapitre 8:

ASP.Net Core Web API

Web API
Qu’est ce qu’une Web API

• Une API, ou interface de programmation d'application, est un ensemble de

définitions et de protocoles qui facilite la création et l'intégration des
applications.

• Les API permettent à votre produit ou service de communiquer avec

d'autres produits et services sans connaître les détails de leur mise en
œuvre.

• Elles simplifient le développement d'applications → gagner du temps et

de l'argent.
 Qu’est ce qu’une Web API
Une API, désigne une interface de programmation
d'application.

• Dans le contexte des API, le terme « application » désigne

tout logiciel ayant une fonction distincte.
• L'interface peut être considérée comme un contrat de
service entre deux applications.
• Ce contrat définit la manière dont les deux parties
communiquent entre elles à l'aide de demandes et de
réponses.
 Comment fonctionne une Web API
• L'architecture des API s'explique en termes de client et de serveur.
• L'application qui envoie la demande est appelée le client, tandis que celle qui
envoie la réponse est appelée le serveur.

Exemple: la météo; la base de données météorologique du bureau est le serveur, et

l'application mobile est le client.
 Mode de fonctionnement d’une API

• Les API peuvent fonctionner de quatre manières différentes,

selon le moment et le motif de leur création.

API SOAP
Ces API utilisent le protocole simple d'accès aux objets (SOAP).
Le client et le serveur échangent des messages via XML.
LA structure des messages SOAP est compliquée ( enveloppe
avec quatre éléments spécifiques)
 Mode de fonctionnement d’une API

• Les API peuvent fonctionner de quatre manières

différentes, selon le moment et le motif de leur
création.

API RPC
Ces API sont appelées appels de procédure à distance
(RPC). Le client exécute une fonction (ou une
procédure) sur le serveur, tandis que le serveur
renvoie la sortie au client.
 Mode de fonctionnement d’une API
API WebSocket
L'API Websocket est un développement d'API web qui utilise des objets JSON pour
transmettre des données.
Une API WebSocket prend en charge la communication bidirectionnelle entre les applications
client et le serveur.
Elle permet d’ouvrir un canal de communication interactif (bidirectionnel) permanent entre
un navigateur (côté client) et un serveur,

Exemple: Pouvoir envoyer des messages

• Pouvoir recevoir des messages
• tous les messages envoyés sont immédiatement retransmis aux autres participants
• De ce fait vous avez 2 canaux d'ouverts en même temps, l'un pour les envois, l'autre pour la réception
 Mode de fonctionnement d’une API
API Rest
Ce sont les API les plus demandées et les plus flexibles que l'on retrouve aujourd'hui sur le
web. Le client adresse des demandes au serveur sous forme de données.
Le serveur utilise les données du client pour exécuter des fonctions internes et renvoie les
données de sortie au client.
 REST…?
❑ REST est l'abréviation de Representational State Transfer.
❑ REST définit un ensemble de fonctions comme GET, PUT, DELETE, etc., que les clients
peuvent utiliser pour accéder aux données du serveur.
❑ Les clients et les serveurs échangent des données au moyen du protocole HTTP.
❑ La principale fonction de l'API REST consiste à être sans état (stateless).
→L'absence d'état signifie que les serveurs ne sauvegardent pas les données du client entre
les demandes.
➢ Les demandes du client adressées au serveur sont similaires aux URL que vous
saisissez dans votre navigateur pour consulter un site web.
➢ La réponse du serveur est constituée de données simples, sans le rendu graphique
classique d'une page web.
 Rest Web API en ASP.NET Core

❑ Les contrôleurs MVC et les contrôleurs d’API web ASP.NET Core sont unifiés.
❑ Architecture assurant la testabilité.
❑ Capacité à développer et à s’exécuter sur Windows, macOS et Linux.
❑ Possibilité d’héberger sur Kestrel, IIS, HTTP.sys, Nginx, Apache et Docker.
❑ Injection de dépendances intégrée.

❑ Une action de contrôleur d’API web peut retourner l’une des actions suivantes :

• void
• HttpResponseMessage
• IHttpActionResult
• Un autre type
 Routage du Rest Web API

❑ Au lieu d’utiliser la convention d’affectation de noms pour les verbes HTTP, vous
pouvez spécifier explicitement le verbe HTTP pour une action en décorant la
méthode d’action avec l’un des attributs suivants :
Action Verbs du Rest Web API

Si besoin de supporter plus qu’une méthode → ACCEPTVERBS

Exemple: [AcceptVerbs("POST", "PUT")]

Status Codes du Rest Web API
 Format des données du Rest Web API

• Web API peuvent retourner des données sous Format XMl ou JSOn
Web API utilise Media Formatter pour:
• Sérialiser les informations que le web API retourne
• Contrôler Media Type au niveau du Header
• Formatter tous le contenu que le serveur envoie aux services
clients