Comment fonctionnent les API repos

Comment fonctionnent les API repos
Les API de repos ou de repos sont partout ces jours-ci. Vous l'avez peut-être utilisé même sans rien en savoir. Dans cet article, je parlerai des API REST. Je vais discuter de la façon dont ils fonctionnent, de leurs applications et bien d'autres. Commençons.

Pourquoi utiliser l'API REST:

Dans les applications Web traditionnelles, disons un simple serveur Web PHP,

  • Vous demandez une page (disons php) à partir du serveur.
  • Le serveur trouve le fichier de script (php) correspondant à la page que vous avez demandée et commence à l'exécuter. Le script se connecte à la base de données, recherche les informations requises, place les informations dans la page de manière bien formatée (mélangeant HTML + CSS + JavaScript avec les données) qui semble très attrayante pour le visiteur.
  • Ensuite, le serveur le renvoie au visiteur.

Dans ce modèle, tout le traitement est effectué du côté du serveur. Le serveur doit donc faire plus de travail. Ici, les données ne sont pas distinctes de la page, elles sont profondément intégrées dans la page.

Si à l'avenir, vous souhaitez créer une application Android ou une application iOS ou une application de bureau de votre site Web, vous devrez faire beaucoup plus de travail. Vous devrez vous connecter à la base de données directement à partir de chacune de ces applications, ce qui peut ne pas être très sécurisé. Le temps de développement augmentera et les problèmes de portabilité se poseront.

Disons que vous avez réussi à créer des applications de bureau, Android et iOS de votre site Web. Le nom complet de l'utilisateur s'affiche en minuscules dans chacun d'eux. Maintenant, vous aimeriez le montrer en majuscule. Eh bien, les développeurs doivent modifier séparément la version de bureau, Android et iOS de votre application afin de le faire. Qui prend du temps. Dans le monde réel, les choses ne seront pas aussi simples que celle-ci. Ainsi, une version de l'application (disons la version de bureau) peut avoir un bogue sérieux dans le processus de mise à jour. Le réparer plus tard prendrait plus de temps. Pouvez-vous voir comment le temps de développement augmente? Cette solution n'est pas également portable.

Dans l'API REST, vous demandez au serveur API ce dont vous avez besoin et il vous envoie uniquement les informations que vous demandez, aucune mise en forme supplémentaire n'est effectuée dans le serveur. Il n'y a pas besoin de traitement inutile dans le serveur. Ainsi, les performances de votre site Web et de vos applications sont naturellement améliorées. Vous pouvez également utiliser les mêmes données dans votre site Web, votre application de bureau, Android et iOS. Les modifications apportées aux serveurs seront reflétées dans les applications qui utilisent l'API. Le temps de développement des applications et le coût seront également réduits.

Comment fonctionnent l'API REST:

Les API de repos ont des critères de terminaison. Un point final n'est rien d'autre qu'une URL, mais d'une manière bien formatée et c'est significatif. Il utilise les demandes HTTP natives (comme OBTENIR, POSTE, METTRE, SUPPRIMER etc) pour décider quoi faire lorsque vous accédez à chaque point de terminaison. J'en parlerai plus tard.

Le format de sortie de l'API REST est également connu sous le nom de notation d'objet JavaScript.

Un exemple de la sortie d'un OBTENIR Demande à l'API de repos sur / utilisateurs / id / 12 Le point de terminaison peut sembler comme suit:


"id": 12,
"Nom": "David Smith",
"Age": 42,
"téléphones": ["124-211-2341", "889-211-4545"],
"pays": "nous"

Comme vous pouvez le voir, j'ai fait un OBTENIR demander / utilisateurs / id / 12 Point de terminaison pour dire à l'API du reste de me donner des informations sur l'utilisateur qui a le identifiant 12. J'ai juste les informations que j'ai demandées, rien de plus, rien de moins.

Disons maintenant que vous voulez des informations sur les 10 derniers utilisateurs qui se sont inscrits sur votre site Web. Vous pouvez faire un OBTENIR demander / utilisateurs / le dernier / 10 point final.

Vous pouvez également ajouter de nouvelles données sur votre serveur à l'aide de l'API REST. Habituellement, le HTTP POSTE La demande est utilisée pour demander à l'API REST d'ajouter de nouvelles données au serveur API.

Par exemple, vous pouvez faire un POSTE demander /utilisateurs Point de terminaison avec les données du nouvel utilisateur et il sera ajouté à la base de données sur votre serveur API. Vous pouvez également configurer votre API pour retourner l'état de la demande.


"Statuscode": 400,
"StateStext": "l'utilisateur a ajouté avec succès.",
"données":
"Id": 13,
"Nom": "Mary Smith",
"Age": 35,
"téléphones": ["124-211-2341", "889-211-4545"],
"pays": "nous"

Comme vous pouvez le voir, le code de statut et statistique La propriété de l'objet JSON informe le client API que l'utilisateur est ajouté avec succès. Les données ajoutées sont également renvoyées dans le données propriété de l'objet JSON. Vous pouvez configurer votre API comme vous le souhaitez.

Vous pouvez également mettre à jour un enregistrement existant à partir de la base de données du serveur API. Le METTRE La demande HTTP est utilisée sur un point de terminaison de l'API pour mettre à jour les données existantes sur la base de données de votre serveur API.

Par exemple, disons que vous souhaitez mettre à jour le numéro de téléphone de l'utilisateur avec l'ID 13. Vous pouvez faire un METTRE demande sur le point de terminaison de l'API / utilisateur / id / 13.


"Statuscode": 200,
"StateStext": "Utilisateur mis à jour.",
"old_data":
"Id": 13,
"Nom": "Mary Smith",
"Age": 35,
"téléphones": ["124-211-2341", "889-211-4545"],
"pays": "nous"
,
"nouvelles données":
"Id": 13,
"Nom": "Mary Smith",
"Age": 35,
"téléphones": ["100-211-1111", "140-211-1145"],
"pays": "nous"

Comme vous pouvez le voir, l'opération de mise à jour est réussie. Les anciennes données et les nouvelles données sont renvoyées dans le old_data et nouvelles données propriété de l'objet JSON respectivement.

Vous pouvez également supprimer les données de la base de données du serveur API avec le HTTP SUPPRIMER demande sur le point de terminaison de l'API.

Par exemple, pour supprimer l'utilisateur avec l'ID 12, vous pouvez faire un SUPPRIMER demande sur le point de terminaison de l'API / utilisateur / id / 12.


"Statuscode": 150,
"StateStext": "Utilisateur supprimé.",
"données":
"id": 12,
"Nom": "David Smith",
"Age": 42,
"téléphones": ["124-211-2341", "889-211-4545"],
"pays": "nous"

Comme vous pouvez le voir, l'utilisateur est supprimé et les données utilisateur supprimées sont renvoyées dans le données propriété de l'objet JSON.

J'ai expliqué la façon standard d'utiliser le OBTENIR, POSTE, METTRE et SUPPRIMER Demande HTTP sur les points de terminaison de l'API à faire Crud (créer, lire, mettre à jour et supprimer). Mais vous pouvez configurer votre API pour faire certaines choses sur certaines demande HTTP. Rien n'est réparé ici. Par exemple, vous pouvez mettre à jour l'API en utilisant OBTENIR Demande HTTP. Vous n'avez pas à utiliser METTRE. C'est à la concepteur d'API.

Vous concevez également les points de terminaison de l'API. Donner des noms significatifs à vos points de terminaison API Rendez votre API REST beaucoup plus facile à utiliser.

Applications de l'API REST:

Les API facilitent le développement des applications et modulaire. Avec l'aide de l'API REST, vous pouvez facilement porter votre application sur différentes plates-formes.

Tout ce que vous avez à faire est de concevoir et de développer une API REST de votre application. Ensuite, vous pouvez utiliser votre API REST à partir de votre site Web, de votre application Android, de l'application iOS, de l'application Windows Desktop et de l'application Linux, etc. De cette façon, toutes vos applications sur une plate-forme différente utiliseront la même logique et votre temps de développement et votre coût seront réduits. Les applications seront également plus faciles à gérer. Les API REST sont utilisées rapidement dans les applications Web d'une seule page ces jours-ci.

J'ai écrit un article sur la rédaction d'API REST en utilisant Python. Merci d'avoir lu cet article.