WordPress: Tutoriel API Web – JavaTpoint

WordPress: Tutoriel API Web - JavaTpoint

Tutoriel de l'API Web Asp.Net

Dans ce tutoriel, nous aborderons les sujets suivants :

Le didacticiel de l’ fournit des concepts de base et avancés d’ASP.NET. Notre didacticiel ASP.NET est conçu pour les débutants et les professionnels.

Qu’est-ce que l’API Web ?

  • L’API Web est la forme améliorée de l’application Web pour fournir des services sur différents appareils tels qu’un ordinateur portable, un mobile et autres.
  • Aujourd’hui, toutes sortes d’entreprises utilisent Internet comme moyen rentable de développer leurs activités sur le marché international.
  • application Web aide à échanger des informations sur Internet et permet également d’effectuer une transaction sécurisée sur des sites Web.
  • Les applications Web sont populaires car le navigateur Web est disponible dans défaut, nous n’avons besoin d’aucune installation de logiciel sur les ordinateurs dotés de systèmes d’exploitation.
  • Par exemple, Facebook (une application Web de réseautage social), Flickr (une application Web de partage de photos) et Wikipedia sont des exemples d’application Web les plus utilisés.
  • Techniquement, une application web se compose de deux types de scripts :

1) Scripts côté client : JavaScript, HTML et d’autres langages de script côté client sont utilisés pour concevoir les formulaires Web afin de présenter des informations aux utilisateurs.

2) Scripts côté serveur : ASP et d’autres langages de script côté serveur sont utilisés pour effectuer des opérations liées à la logique métier et à la base de données, telles que le stockage et la récupération d’informations.

  • Une application Web est Interaction Homme-Système.
  • Soit il peut s’agir d’une application d’une seule page uniquement pour fournir des informations à une entreprise, soit il peut s’agir d’un ensemble de pages Web utilisées pour obtenir des informations de l’utilisateur et lui fournir des services.

Qui utilise l’API ?

Ces services sont accessibles à différents types d’utilisateurs tels que :

  • Navigateurs Web
  • Applications mobiles
  • Applications de bureau
  • IOT (Internet des objets)

API signifie Interface de programmation d’applications.

« ASP.NET Web API est un cadre extensible pour la création de services HTTP (Hypertext Transfer Protocol) accessibles à partir de n’importe quel client tel que les navigateurs et les appareils mobiles. »

Par exemple, nous effectuons une réservation à partir de différentes applications Web telles que MakeMyTrip, Ixigo ou Paytm et toutes les autres applications Web de réservation, mais toutes les applications effectuent une réservation en utilisant uniquement les informations d’identification du site Web IRCTC.

Ces services sont accessibles à différents types d’utilisateurs tels que :

  • Navigateurs Web
  • Applications mobiles
  • Applications de bureau
  • IOT (Internet des objets)

Les services d’API Web sont utilisés lorsque l’application doit être utilisée sur un système distribué.

L’API Web prend les demandes des différents types d’appareils clients tels que les mobiles, les ordinateurs portables, etc. et les envoie au serveur Web pour les traiter et renvoie les données souhaitées au client.

Tutoriel de l'API Web Asp.Net

Application Web personnalisée utilisant un autre type d’API

L’API Web est Interaction système-système, où les informations d’un système sont traitées par un autre système, et les données résultantes sont montrées à l’utilisateur.

Prenons un autre exemple parmi les exemples d’API Web, nous voulons un burger McDonald’s.

Supposons que McDonald’s n’autorise les plats à emporter qu’aux cuisiniers et non aux autres. Ici, McDonalds-Takeaways (cook) est comme une API, qui permet à d’autres systèmes (cooks) d’accéder aux services et de fournir les données souhaitées.


Fonctionnalités de l’

1) L’ est très similaire à ASP.NET MVC.

2) Il contient des fonctionnalités similaires à celles d’ASP.NET MVC telles que :

  • Routage
  • Contrôleurs
  • Résultats des actions
  • Filtre
  • Modèle, etc…

3) Il existe une idée fausse selon laquelle l’ fait partie du framework ASP.NET MVC, alors qu’elle peut être utilisée avec tout autre type d’application Web.

4) Des services autonomes peuvent être développés à l’aide de l’API Web.

5) Le framework d’ est largement utilisé pour développer Reposant prestations de service.


Des services reposants

  • L’API Web est la forme améliorée d’une application Web.
  • SOAP (protocole d’accès aux objets simples) était un protocole basé sur XML pour développer les applications Web connectées.
  • Le problème avec le SOAP était qu’à chaque demande, Métadonnées est joint aux données à transférer.
  • Ces métadonnées convertissent les petites données en données lourdes sur le serveur.
  • API Web peut être ou non Reposant services, mais ils sont toujours Basé sur HTTP prestations de service.
  • REST signifie Transfert d’État représentatif.
  • Dans l’API REST, seul le état de l’objet est envoyé au serveur pour trouver le résultat souhaité.
  • DU REPOS est un modèle architectural pour développer une API qui utilise HTTP comme méthode de communication sous-jacente.

Lorsque nous utilisons un service basé sur HTTP, par exemple, l’application BookMyShow, nous avons besoin de données sous une forme gérée comme le format JSON, le format XML.

Le client demande des informations en envoyant des paramètres à l’aide de Méthodes API.

Tutoriel de l'API Web Asp.Net

Par exemple, si nous voulons réserver une émission pour laquelle nous voulons connaître les détails comme la ville, le nom du film, le lieu, l’horaire. Nous enverrons l’état de l’objet au serveur Web et l’API vérifiera si les données sont disponibles ou non.

Si les données sont disponibles (le film est disponible pour cette instance), alors il renverra la réponse au client avec l’objet.

Les valeurs d’un objet sont envoyées au client, c’est-à-dire que l’état d’un objet est envoyé au client, donc à chaque fois vous n’avez pas besoin de créer un objet.

 » L’API REST est un style architectural ainsi qu’une approche à des fins de communication souvent utilisée dans divers développements Web.  »

C’est un apatride, modèle client-serveur.

Tutoriel de l'API Web Asp.Net


Principes de l’API REST

Les six principes de l’API REST sont :

  1. Apatride
  2. Serveur client
  3. Interface uniforme
  4. Cacheable
  5. Système en couches
  6. Code sur demande

1) Apatride : Lorsque la requête du client est envoyée au serveur, elle contient toutes les informations nécessaires pour que le serveur la traite. Une demande peut faire partie de QueryString ou d’une URL.

Par exemple, supposons que la ressource soit demandée à partir de l’URL (Uniform Resource Locator).

Tutoriel de l'API Web Asp.Net

2) Client-Serveur : La séparation des fonctionnalités permet d’augmenter la portabilité de l’interface utilisateur sur plusieurs plates-formes et d’étendre l’évolutivité des composants du serveur.

3) Interface uniforme : Pour obtenir l’uniformité dans toute l’application, REST a défini quatre contraintes d’interface pour lesquelles sont :

  • Identification des ressources
  • Manipulation des ressources à l’aide de représentations
  • Massages auto-descriptifs
  • Et l’hypermédia comme moteur de l’application web

4) Cacheable : Afin d’offrir de meilleures performances, les applications sont mises en cache. Cela se fait en marquant la réponse comme pouvant être mise en cache ou non, implicitement ou explicitement. Si la ressource est définie pouvant être mise en cache, le cache client peut réutiliser les données de réponse pour les demandes d’équivalence.

5) Système en couches : Le système en couches permet à une application d’être plus stable en limitant le comportement des composants. L’architecture en couches contribue également à améliorer la sécurité, car le composant de chaque couche ne peut pas interagir au-delà de chaque couche dans laquelle il se trouve.

6) Code sur demande : Contrainte qui est utilisée facultativement et la moins. Analysez et simplifiez le client en créant une application intelligente qui ne repose pas sur sa propre structure de code.


Méthodes de l’API REST

  • Travaillant sur les technologies web, nous travaillons sur des applications CRUD.
  • Dans ces applications, CRUD consiste à CRÉER, LIRE, METTRE À JOUR et SUPPRIMER une ressource.
  • Ici, une ressource est définie comme le résultat souhaité. Par exemple : https://in.bookmyshow.com/noida/movies
  • Dans l’exemple ci-dessus, l’utilisateur recherche des films dans la ville de Noida sur l’application bookmyshow, donc la ressource est les données que le client recherche.
  • Pour effectuer ces actions telles que créer une ressource, lire une ressource, mettre à jour une ressource ou supprimer une ressource, nous pouvons utiliser des méthodes HTTP également appelées méthodes REST.

Maintenant, les opérations CRUD de base sont mappées aux protocoles HTTP de la manière suivante :

Méthodes CRUDMéthodes de l’API RESTLa description
CréerPUBLIERLa méthode fait référence à la partie C(Create) du CRUD.
Il est utilisé pour créer une ressource.
LireAVOIRLa méthode fait référence à la partie R(Retrieve) du CRUD.
Il est utilisé pour lire une ressource.
Mettre à jourMETTRELa méthode fait référence à la partie U(Update) du CRUD.
Il est utilisé pour mettre à jour une ressource.
EffacerEFFACERLa méthode fait référence à la partie D(Supprimer) du CRUD.
Il est utilisé pour supprimer une ressource.
  • L’API REST est mieux utilisée pour les systèmes distribués.
  • Une base de données distribuée est utilisée partout, la base de données stocke des données sur lesquelles les opérations CRUD (Créer, Récupérer, Mettre à jour et Supprimer) sont effectuées.

Prenons donc un exemple pour obtenir des plats de la ressource :

www.testwebsite.com/plats

Supposons maintenant que nous voulons un plat spécifique de la ressource :

www.testwebsite.com/plats/2


Implémentation de l’API REST Application simple

Créons un service API REST pour les étudiants.

  • Tout d’abord, ouvrez Visual Studio (ici, nous avons Visual Studio 2019).
  • Maintenant, sélectionnez Créer un nouveau projet :

Tutoriel de l'API Web Asp.Net

  • Sélectionnez maintenant le modèle Application Web ASP.NET (.NET Framework) avec C# et nommez le projet comme « WebApiÉtudiantsÉchantillon« .

Tutoriel de l'API Web Asp.Net

  • Dans la boîte de dialogue Projet ASP.NET, sélectionnez le Modèle vide et vérifier aussi API Web option. Cliquez sur d’accord.

Tutoriel de l'API Web Asp.Net

  • Une structure par défaut générée sera la suivante :

Tutoriel de l'API Web Asp.Net

Ajout de la classe Student.cs au dossier Models

  • Ajouter une classe avec le nom « Étudiant » pour définir des propriétés et d’autres logiques métier. Nous pouvons également définir d’autres logiques comme la validation, l’accès aux données, etc.
  • Cliquez avec le bouton droit sur Modèles, sélectionnez l’option Ajouter, puis sélectionnez Classe et donnez un nom à la classe comme « Etudiant.cs« 

Tutoriel de l'API Web Asp.Net

Ajoutez le code suivant pour définir les propriétés de la classe des étudiants :

espace de noms WebApiStudentsSample.Models
{
classe publique Etudiants
{
public int StudentId
{
avoir;
ensemble;
}
chaîne publique StudentName
{
avoir;
ensemble;
}
chaîne publique Adresse
{
avoir;
ensemble;
}
cours de chaîne publique
{
avoir;
ensemble;
}

}
}

Ajout de la classe StudentControllers.cs au dossier Controllers

  • La classe Controller gère la requête HTTP du client, qui peut être une application de bureau, un appareil mobile et un navigateur.
  • Faites un clic droit sur Contrôleurs, Sélectionnez Ajouter une option, puis sélectionnez ‘Manette..‘.

Tutoriel de l'API Web Asp.Net

Ajouter un échafaudage la fenêtre s’ouvrira puis sélectionnez Contrôleur Web API2 ? Vide modèle.

Tutoriel de l'API Web Asp.Net

  • Après avoir sélectionné le modèle d’échafaudage, la fenêtre Ajouter un contrôleur s’ouvrira et donnera un nom à la classe comme « ÉtudiantContrôleur« .

Tutoriel de l'API Web Asp.Net

Remarque : Nous pouvons voir que la classe Controller hérite de la classe System.Web.Http.ApiController au lieu de la classe Controller.

  • Échafaudage crée un « StudentController.cs » classe à l’intérieur du manette dossier.

Implémentez maintenant des méthodes pour effectuer des opérations CRUD. Supposons que nous voulons tous les détails des étudiants et également les détails d’un étudiant spécifique.

Ajoutez maintenant le code suivant :

en utilisant le système ;
en utilisant System.Collections.Generic ;
en utilisant System.Linq ;
en utilisant System.Net ;
en utilisant System.Net.Http ;
en utilisant System.Web.Http ;
en utilisant WebApiStudentsSample.Models ;

espace de noms WebApiStudentsSample.Controllers
{
classe publique StudentController : ApiController
{
IListe Étudiants = nouvelle liste()
{
nouveaux étudiants()
{
StudentId = 1, StudentName = « Mukesh Kumar », Adresse = « New Delhi », Course = « IT »
},
nouveaux étudiants()
{
StudentId = 2, StudentName = « Banky Chamber », Address = « Londres », Course = « HR »
},
nouveaux étudiants()
{
StudentId = 3, StudentName = « Rahul Rathor », Adresse = « Laxmi Nagar », Course = « IT »
},
nouveaux étudiants()
{
StudentId = 4, StudentName = « YaduVeer Singh », Adresse = « Goa », Course = « Ventes »
},
nouveaux étudiants()
{
StudentId = 5, StudentName = « Manish Sharma », Address = « New Delhi », Course = « HR »
},
} ;
liste IL publique ObtenirTous les étudiants()
{
//Renvoyer la liste de tous les employés
retour Étudiants;
}
public Étudiants GetStudentDetails(int id)
{
//Renvoyer un seul détail d’employé
var Student = Students.FirstOrDefault(e => e.StudentId == id);
si (Etudiant == nul)
{
lancer une nouvelle exception HttpResponseException(Request.CreateResponse(HttpStatusCode.NotFound));
}
retour Étudiant;
}
}
}

Dans le ÉtudiantContrôleur contrôleur de classe, vous pouvez voir que la méthode « ObtenirTous les étudiants » retourner la liste de tous les élèves et la méthode « Obtenir les détails de l’élève » renvoie le détail du single étudiant.

Dans le tableau suivant, vous pouvez comprendre comment le contrôleur utilise l’URL de route pour effectuer l’action CRUD.

Méthode du contrôleurURI de route (identificateur de ressource uniforme)
ObtenirTous les étudiants/api/ étudiant
Obtenir les détails de l’élève/api/ étudiant /identifiant

Exécuter l’API Web

Pour exécuter une API Web, appuyez d’abord sur F5 ou Ctrl + F5 ou cliquez sur l’icône d’exécution express IIS, puis le navigateur s’ouvrira avec l’URL comme https://localhost:44329/

Maintenant, pour trouver la liste de tous les étudiants, modifiez l’URL comme https://localhost:44329/api/student

Tutoriel de l'API Web Asp.Net

Pour récupérer les détails d’un seul étudiant, modifiez l’URL comme suit :

https://localhost:44329/api/student/2

Tutoriel de l'API Web Asp.Net


Besoin d’API Web

  • Une API Web permet d’accéder aux données de service à partir de différents appareils Internet tels que les navigateurs, les applications mobiles et d’autres appareils.
  • Aide à travailler sur les services Web RESTful.
  • Aide à développer des services Web légers et maintenables.
  • Utilisé pour créer les deux types de et les services non RESTful.
  • Prend également en charge JSON, XML et d’autres formats de données.
  • Aide à développer des services prenant en charge toutes les fonctionnalités des services HTTP tels que comme mise en cache, en-têtes de demande/réponse, gestion des versions, etc.

Les différences entre l’API ASP.NET et ASP.NET MVC sont les suivantes :

MVCAPI Web
Aide à développer des applications Web qui traitent la demande et envoient à la fois des vues et des données.Aide à développer des services HTTP ( et non RESTful) qui traitent la demande et renvoient uniquement des données, pas une vue.
Représente les données résultantes au format JSON à l’aide de JsonResult.Renvoyer des données dans un format particulier comme JSON, XML ou tout autre format
Une demande est mappée au nom des actions.Une requête est mappée sur des verbes HTTP dans l’API Web
La liaison de modèle, le routage et d’autres fonctionnalités sont définis dans System.Web.Mvc.Les mêmes fonctionnalités sont disponibles dans l’API Web, et ces fonctionnalités sont définies dans l’assembly System.Web.Http.
MVC interagit généralement avec les vues pour fournir la sortie finalePrend en charge la fonctionnalité de négociation de contenu, c’est-à-dire décider du meilleur format pour les données de réponse qui est compatible avec la machine cliente.

API Web contre WCF

Les différences entre ASP.NET WCF et ASP.NET Web API sont les suivantes :

CaractéristiqueAPI WebWCF
Format de contenuL’API Web prend en charge tous les formats multimédias tels que XML, JSON, etc.WCF prend en charge les services basés sur SOAP et le format XML.
HébergementL’API Web prend en charge l’hébergement IIS, l’auto-hébergementWCF prend en charge les services d’activation des travaux ainsi que l’hébergement IIS, l’auto-hébergement.
Fonctionnalités MVCL’ prend en charge des fonctionnalités telles que les contrôleurs, le routage, l’action, etc., de la même manière que MVC.Comme MVC, WCF ne fournit aucune fonctionnalité comme les contrôleurs, le routage, le filtre, les résultats des enchères, etc.
ProtocoleL’API Web prend en charge le protocole HTTP.UDP, HTTP et les protocoles de transport personnalisés sont pris en charge.
Utilisation du modèleUtilise des verbes HTTP en tant que méthodes appelées opérations CRUDContrat de service L’attribut définit un contrat de service qui contient des opérations.
OpérationContrat L’attribut définit les opérations qui seront utilisées.
Contrat de données L’attribut définit les propriétés ou les types qui seront transférés entre les parties.

Les différences entre l’API Web et les services Web sont les suivantes :

CaractéristiquesAPI Webservices Web
HébergementL’hébergement se fait au sein d’une application ou IIS.L’hébergement se fait sur IIS.
Open sourceL’API Web est open source et peut être utilisée par tout client prenant en charge JSON ou XML.Le service Web n’est pas open source mais peut être utilisé par tout client prenant en charge XML.
ArchitectureL’API Web est une architecture légère et convient aux appareils qui ont une bande passante limitée, comme les appareils mobiles.Il nécessite un protocole SOAP pour recevoir et envoyer des données sur le réseau, ce n’est donc pas une architecture légère.
ProtocoleIl prend en charge le protocole HTTP : URL, en-têtes de demande/réponse, versioning, mise en cache, formats de contenu.Il prend uniquement en charge le protocole HTTP.

L’authentification et l’autorisation de l’ sont des concepts importants pour la sécurité de l’API Web.

Supposons qu’une API Web soit créée et que l’accès à l’API soit pour certains utilisateurs spécifiques, et que différentes opérations soient également disponibles pour différents utilisateurs.

  • Authentification est de valider les informations d’identification de l’utilisateur et de les identifier.
    Par exemple, un utilisateur se connectant avec son nom d’utilisateur et son mot de passe et le serveur authentifient l’utilisateur par un mot de passe.
  • Autorisation consiste à définir le niveau d’accès de chaque utilisateur pour effectuer une opération différente.
    Par exemple, une personne est autorisée à créer une ressource mais pas à supprimer l’enregistrement.

Si une demande nécessite une authentification dans l’API Web, mais que le client ne fournit pas les informations d’identification dans l’en-tête de la demande, le serveur renvoie 401 (non autorisé).


Prérequis

Avant d’apprendre l’API Web, l’utilisateur doit avoir des connaissances de base sur les méthodes Http, les propriétés C# et la connaissance de MVC sera un plus.

Public

Ce tutoriel est destiné aux débutants et aux professionnels pour apprendre l’API Web et les .

Problèmes

Ce tutoriel est disponible dans un langage simple et facile encore, en cas de confusion, veuillez poster le doute dans le formulaire de contact.


.

All the CMS Templates You Could Ask For.

WordPress: Tutoriel API Web - JavaTpoint

2M+ items from the worlds largest marketplace for CMS TemplatesEnvato Market.



WordPress: Tutoriel API Web - JavaTpoint

#Tutoriel #API #Web #JavaTpoint