Share
Dans ce tutoriel, vous verrez comment commencer à configurer et à utiliser un faux serveur d'API REST à l'aide de json-server, que vous pouvez utiliser lors du développement d'applications mobiles ou Web. Ce tutoriel suppose que vous maîtrisiez les requêtes JSON et HTTP..
REST est synonyme de Representational State Transfer. C'est un style d'architecture pour la conception d'applications connectées. Il utilise un simple HTTP pour rendre possible la communication entre les machines. Ainsi, au lieu d'utiliser une URL pour manipuler certaines informations utilisateur, REST envoie une requête HTTP telle que GET, POST, DELETE, etc. à une URL pour manipuler des données..
Par exemple, au lieu de faire une requête GET à une URL telle que / deleteuser? id = 10, la demande serait comme DELETE / utilisateur / 10.
Les API REST constituent le back-end des applications Web et mobiles. Lors du développement d'applications, les API REST ne sont parfois pas prêtes à être utilisées à des fins de développement. Pour voir l'application mobile ou Web en action, nous avons besoin d'un serveur qui envoie des données fictives JSON..
C'est à ce moment que la fausse API REST entre en scène. serveur json fournit la fonctionnalité permettant de configurer un faux serveur d'API REST avec un minimum d'effort.
Pour commencer à utiliser serveur json, installer le paquet en utilisant Node Package Manager (npm).
npm install -g json-server
Créez un fichier JSON factice avec certaines données selon vos besoins. Par exemple, j'ai besoin de données JSON avec des informations utilisateur telles que l'id, le nom, l'emplacement, etc. Je crée donc un fichier appelé info.json avec les informations JSON suivantes:
"utilisateurs": ["id": 1, "nom": "roy", "emplacement": "inde", "id": 2, "nom": "sam", "emplacement": " Pays de Galles" ]
Depuis le terminal, lancez le serveur JSON avec info.json en tant que source de données et que l'API REST s'exécute à l'adresse http: // localhost: 3000.
json-server info.json
Puisque notre faux serveur d'API REST est opérationnel, voyons comment accéder à l'API REST à l'aide d'un client. J'utilise le client Postman REST pour effectuer les appels d'API.
Commençons par faire un OBTENIR demande à l'URL REST. Dans le fichier json, nous avons défini un noeud final utilisateurs qui contient des informations relatives aux utilisateurs. En faisant un OBTENIR demande à l'URL http: // localhost: 3000 / users, il devrait afficher les données existantes.
["id": 1, "name": "roy", "location": "india", "id": 2, "name": "sam", "location": "wales"]
Afin d’ajouter de nouvelles données aux données existantes, nous allons faire un POSTER demande à l'URL http: // localhost: 3000 / users. Voici ce que le POSTER demande ressemblerait à:
Essayez de faire un OBTENIR demande et vous devriez avoir les données nouvellement ajoutées dans le info.json fichier.
["id": 1, "name": "roy", "location": "india", "id": 2, "name": "sam", "location": "wales", "nom": "ii", "emplacement": "la", "id": 7, "nom": "Shona", "emplacement": "LA", "id": 8, "nom ":" Shona "," location ":" LA "," id ": 9]
Pour supprimer une entrée du serveur json données, vous devez envoyer un EFFACER demande au noeud final de l'API avec l'ID utilisateur. Par exemple, pour supprimer l’utilisateur avec l’ID 1, vous devez envoyer un message. EFFACER requête au noeud final http: // localhost: 3000 / users / 1. Une fois supprimé, essayez de faire une OBTENIR demande, et l'utilisateur avec l'Id 1 ne doit pas être dans le JSON retourné.
Pour mettre à jour une entrée existante, vous devez envoyer un PIÈCE requête avec les détails à mettre à jour pour cette entrée. Par exemple, afin de mettre à jour les détails de l’utilisateur avec l’ID 2, nous vous enverrons un message. PIÈCE demande à l'URL http: // localhost: 3000 / users / 2 comme indiqué:
En utilisant serveur json API REST, vous pouvez rechercher dans les données pour rechercher des données en fonction de certains critères. Par exemple, pour rechercher des utilisateurs avec un nom particulier, vous devez envoyer une demande GET à l'URL de l'API REST, comme indiqué:
Comme indiqué dans l'image ci-dessus, l'envoi d'une demande GET à l'URL http: // localhost: 3000 / users? Name = Shona renverrait les utilisateurs avec le nom correspondant. Shona. De même, pour rechercher des utilisateurs avec d’autres champs, vous devez ajouter ce champ à la chaîne de requête..
Pour exécuter une recherche en texte intégral sur le point de terminaison de l'API REST, vous devez ajouter la chaîne de recherche avec le paramètre. q au point final. Par exemple, pour rechercher des utilisateurs avec des informations contenant une chaîne de recherche s, la demande ressemblerait à ceci:
Lors de l'affichage d'une grille de données paginée, il serait nécessaire d'extraire certaines données en fonction de la pagination. Dans de tels scénarios, serveur json fournit la fonctionnalité pour paginer les données JSON. Par défaut, le nombre de données renvoyées par serveur json est 10. Nous pouvons définir explicitement cette limite en utilisant le _limite paramètre.
http: // localhost: 3000 / users? _limit = 5
Une demande GET à l'URL ci-dessus renverrait cinq enregistrements. Maintenant, pour paginer les données, nous devons ajouter un autre paramètre _page à l'URL. _page définit la page à récupérer au retour des données.
http: // localhost: 3000 / users? _limit = 5 & _page = 2
Une requête GET adressée à l'URL ci-dessus renverrait la deuxième page du jeu de données avec cinq enregistrements par page. En changeant le _page variable, nous pouvons récupérer les enregistrements de page requis.
serveur json fournit la fonctionnalité pour trier les données récupérées. Nous pouvons trier les données en fournissant le nom de la colonne à trier et l’ordre dans lequel les données doivent être triées. Par défaut, les données sont triées par ordre croissant. Nous pouvons fournir le nom de la colonne dans l'URL du noeud final à l'aide du mot clé _Trier et définir l'ordre en utilisant le mot clé _ordre. Voici un exemple d'URL:
http: // localhost: 3000 / users? _sort = id & _order = DESC
L'URL ci-dessus trierait les données en fonction de la colonne Id, et il serait trié par ordre décroissant.
serveur json fournit également des fonctionnalités permettant aux opérateurs de rechercher une entrée avec un ID compris entre deux valeurs ou une entrée correspondant à une expression régulière particulière.
Pour trouver une entrée dans une plage particulière, nous pouvons utiliser le _gte et _lte les opérateurs. Par exemple, pour rechercher des utilisateurs avec un ID supérieur à 1 et inférieur à 2, envoyez une demande GET à l'URL http: // localhost: 3000 / users? Id_gte = 1 et id_lte = 2, comme indiqué:
Si nous voulons rechercher des noms commençant par une certaine lettre, nous pouvons utiliser des expressions régulières. Par exemple, pour rechercher des noms commençant par des lettres sa, nous allons utiliser le _comme opérateur et faire un OBTENIR demande à l'URL http: // localhost: 3000 / users? name_like = ^ sa.
Dans ce tutoriel, vous avez vu comment utiliser serveur json API REST pour créer une base de données fictive pour une utilisation rapide. Vous avez appris à commencer à utiliser serveur json et interrogez l'URL pour ajouter, mettre à jour, modifier et supprimer des données. Vous avez vu comment paginer, trier et rechercher les données factices. Vous avez également vu comment utiliser des opérateurs pour rechercher des entrées à l'aide d'expressions régulières.
Avez-vous utilisé serveur json ou tout autre faux serveur API REST pour la création de données factices? Comment était votre expérience? Faites-nous savoir vos pensées dans les commentaires ci-dessous.
Accentsconagua