Codez votre première API avec Node.js et Express: Comprendre les API REST

dans le développement Web moderne, vous devez souvent les termes de repos et API. Si vous avez entendu parler de ces termes ou utilisé des API mais que vous ne comprenez pas complètement comment ils fonctionnent ou comment construire votre propre API, cette série de tutoriels vous convient.

Cette série de tutoriels décrira d'abord les principes et les concepts de repos. Nous allons ensuite créer une API complète qui s'exécute sur le serveur Node.js Express et se connecter à la base de données MySQL. Après avoir terminé cette série de tutoriels, vous devriez être en mesure de construire votre propre API en toute confiance ou de creuser dans la documentation pour les API existantes.

Prérequis

Pour tirer le meilleur parti de ce tutoriel, vous devriez avoir des connaissances de base de la ligne de commande, comprendre les bases de JavaScript et installer Node.js à l'échelle mondiale.

Quelles sont les API REST et RESTFULS?

Le transfert de l'état expressif ( rest ) décrit un style architectural de services Web. REST contient un ensemble de normes ou de contraintes pour partager des données entre différents systèmes. Le repos est un concept abstrait, pas une langue, un cadre ou un type de logiciel.

Une analogie lâche sur le repos est: garder les collections d'enregistrements vinyles et utiliser des services de musique en streaming. Pour les collections d'enregistrements en vinyle physiques, chaque enregistrement doit être copié en entier afin de partager et de distribuer des copies. Cependant, pour les services de streaming, la même musique peut être partagée en permanence par référence à certaines données, telles que les titres de chansons. Dans ce cas, la musique en streaming est un service RESTful, tandis que la collection de disques vinyle est un service non re-rassin.

API est une interface de programmation d'applications, qui est une interface qui permet aux logiciels de communiquer entre eux. API RESTFul n'est qu'une API qui suit les principes et les contraintes de repos. Dans l'API Web, le serveur reçoit une demande via le point de terminaison de l'URL et renvoie une réponse , qui est généralement des données au format JSON.

principe de repos

six contraintes de guidage définissent l'architecture de rest comme suit:

1. Interface unifiée : Les interfaces des composants doivent être les mêmes. Cela signifie utiliser la norme URI pour identifier les ressources - en d'autres termes, des chemins qui peuvent être entrés dans la barre d'adresse du navigateur.
2. Client-Server : Il existe une séparation des préoccupations entre le serveur (Store and Operate Data) et le client (demande et réponse d'affichage).
3. Interaction sans état : Toutes les informations sur chaque demande sont contenues dans chaque demande individuelle et ne dépend pas de l'état de session.
4. CACHEABLE : Les clients et les serveurs peuvent mettre en cache des ressources.
5. Système hydged : Les clients peuvent se connecter au serveur final ou à la couche intermédiaire, comme un équilibreur de charge.
6. Code à la demande (facultatif) : Le client peut télécharger le code, réduisant ainsi la visibilité externe.

Demandes et réponses

Vous connaissez peut-être déjà les URL de toutes les sites Web à partir de HTTPS (version de sécurité). Le protocole de transfert hypertexte ( http ) est une méthode de communication entre les clients et les serveurs sur Internet.

Nous le voyons le plus évidemment dans la barre d'URL du navigateur, mais HTTP peut non seulement être utilisé pour demander des sites Web à partir du serveur. Lorsque vous accédez à une URL sur le Web, vous effectuez réellement Get et d'autres types de demandes.

http fait une demande en ouvrant une connexion TCP (protocole de contrôle de transport) au port du serveur (HTTP, HTTPS), et le serveur d'écoute renvoie l'état et le corps.

La demande doit contenir l'URL, la méthode, les informations d'en-tête et le corps.

Méthode de demande

Il existe quatre méthodes HTTP principales, également appelées verbes HTTP, qui sont couramment utilisés pour interagir avec l'API Web. Ces méthodes définissent les actions à effectuer sur une ressource donnée.

La méthode de la demande HTTP correspond approximativement à l'exemple crud , CRUD représente la création, la mise à jour, la lecture et la suppression . Bien que CRUD se réfère aux fonctions utilisées dans les opérations de base de données, nous pouvons appliquer ces principes de conception aux verbes http dans l'API RESTFul.

 <code> curl -i https://www.google.com </code> 

Le serveur de Google renvoie les éléments suivants:

 <code> http / 2 200 Date: 21 août 2022 19:06:22 GMT Expire: -1 CACE-Control: Private, Private, MAX-ISOCE = CHARSET; 859-1 ... </code> 

Nous pouvons voir le code d'état 200, ainsi que la version de HTTP (ce sera HTTP / 1.1, HTTP / 2 ou HTTP / 3).

Étant donné que cette demande particulière renvoie un site Web, il s'agit de texte / html. Dans l'API RESTFul, vous pouvez voir une demande de curl à Google (à l'exclusion de Google.com) renvoyant une réponse 301 indiquant que la ressource doit être redirigé.

REST API API Point de terminaison

Lorsqu'une API est créée sur le serveur, les données qu'il contient peuvent être accessibles via le point de terminaison. Endpoint est une URL qui peut accepter et traiter les demandes de posts et de supprimer les demandes. L'URL de l'API

se composera de racine, de chemin et de chaîne de requête en option.

• root Par exemple, la racine de https://www.php.cn/link/9fa87e1695a743c 29fa4 peut contenir des protocoles, des noms de domaine et des versions.
• chemin par exemple / utilisateurs / 5: le seul emplacement pour une ressource spécifique.
• Paramètres de requête (facultatif) Par exemple limite = 10, est utilisé pour filtrer la réponse pour ne contenir que dix résultats.

Par exemple, pour obtenir un utilisateur avec ID 5, nous utiliserons / utilisateur / 5.

Convention API REST

Les conventions suivantes doivent être suivies lors de la construction d'une API RESTful:

• Les points de terminaison ne devraient pas afficher les extensions de fichiers : bien que l'API soit la plus susceptible de retourner JSON, l'URL ne devrait pas se terminer en .json.
• Utilisez des noms au lieu de verbes : Par exemple, pour ajouter un utilisateur, nous devons utiliser le point de terminaison / utilisateurs et utiliser la demande de post au lieu du point de terminaison / users / ajouter. L'API doit être développée pour pouvoir gérer plusieurs types de demandes à la même URL.
• Les chemins sont sensibles à la casse et doivent utiliser des lettres et des traits de traits en minuscules au lieu de souligner: par exemple, / users-list est préférable à / users_list.

Toutes ces conventions guident les principes car il n'y a pas de normes de repos strictes à suivre. Cependant, l'utilisation de ces directives rendra votre API cohérente, familière et facile à lire et à comprendre.

Alternatives de repos

Le repos est un excellent outil, mais il existe certaines alternatives qui peuvent aider dans certains cas.

SOAP

SOAP (Simple Object Access Protocol) est une API créée en 1998 et était très populaire avant le repos. Il existe des différences majeures entre eux. Premièrement, le savon a des restrictions beaucoup plus strictes sur les formats de réponse. Deuxièmement, SOAP utilise XML au lieu de JSON, ce qui peut être utile pour les applications hérités, mais est généralement plus grand et plus complexe que JSON équivalent. Enfin, bien que SOAP fonctionne bien avec HTTP, il prend également en charge les protocoles tels que SMTP.

GraphQL

GraphQL est un format API plus récent créé par Facebook qui vise à réduire le nombre de demandes HTTP nécessaires pour obtenir les données en permettant aux clients de dire avec précision au serveur dont il a besoin. Au lieu d'utiliser des chemins d'url, GraphQL a une syntaxe personnalisée pour définir les données dont le client a besoin afin que le client obtienne tout ce dont il a besoin en une seule demande.

Pour une merveilleuse introduction à GraphQL, veuillez consulter ce didacticiel GraphQL.

Conclusion

Dans cet article, nous apprenons quelles sont les API de repos et de repos, comment les méthodes de demande HTTP et le fonctionnement du code de réponse, la structure des URL de l'API et les conventions API RESTful courantes. Dans le prochain tutoriel, nous apprendrons comment mettre toutes ces théories en pratique en configurant un serveur express avec Node.js et en construisant notre propre API.

Cet article a été mis à jour et comprend la contribution de Jacob Jackson. Jacob est développeur Web, écrivain technologique, freelancer et contributeur open source.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!