Astuce rapide: API MOCK REST Utilisation de JSON-Server

Pouvez-vous rapidement prototypifier les applications frontales sans back-end? La création même de l'API de simulation la plus élémentaire peut être longue et à forte intensité de main-d'œuvre. La bibliothèque JSON-Server résout ce problème en fournissant un moyen rapide et facile de créer des API reposantes complexes pour le développement et les tests.

Cette astuce rapide vous apprendra comment créer une API de repos simulée à l'aide de JSON-Server, vous permettant d'obtenir une API complète en fonction de 30 secondes.

Points clés

• La bibliothèque JSON-Server peut être utilisée pour créer rapidement des API RESTful complexes pour le développement et les tests, permettant aux développeurs de prototyper les extrémités avant de leurs applications sans backend.
• JSON-Server fournit des fonctionnalités telles que des filtres, des opérateurs logiques, une pagination et un tri, ce qui aide à créer des API simulées qui peuvent être utilisées pour tester frontal avec une grande quantité de fausses données.
• Avec le module Faker.js, les développeurs peuvent générer des données simulées pour l'API, ce qui rend le processus de développement et de test plus efficace et plus proche de la situation réelle.

Précautions

Vous devriez avoir le principe Restful et la connaissance de base de la façon d'utiliser l'API.

Vous avez besoin des outils suivants:

• Nodejs - JSON-Server est construit sur la base de NodeJS.
• Curl - Utilisé pour tester le routage du serveur simulé.

Utilisateurs de Windows: La page de téléchargement Curl fournit des versions 32 bits et 64 bits de binaires Curl que vous pouvez utiliser pour apprendre les exemples de cet article.

Ce tutoriel suppose que vous utiliserez un terminal de type bash.

Installation

Pour installer JSON-Server, veuillez ouvrir votre terminal et entrer:

$ npm install -g json-server

Cela installera JSON-Server à l'échelle mondiale sur votre système afin que vous puissiez démarrer le serveur à partir de n'importe quel répertoire que vous aimez.

Ressources

Dans l'API RESTful, une ressource est un objet avec un type, des données associées, des relations avec d'autres ressources et un ensemble de méthodes pour fonctionner dessus. Par exemple, si vous créez une API pour un film, un film est une ressource. Vous pouvez utiliser votre API pour appliquer les opérations CRUD à cette ressource.

Créons une API avec /movies Ressources.

Créer des ressources

Créez un fichier nommé db.json et ajoutez-y ce qui suit:

{
  "movies": [
    {"id": 1, "name": "The Godfather", "director":"Francis Ford Coppola", "rating": 9.1},
    {"id": 2, "name": "Casablanca", "director": "Michael Curtiz", "rating": 8.8}
  ]
}

Après l'enregistrement du fichier, démarrez le serveur avec la commande suivante:

$ json-server --watch db.json

c'est tout! Vous avez maintenant une API de films; vous pouvez obtenir des films de ce serveur, ajouter de nouveaux films, supprimer des films et de nombreuses autres actions.

Pour tester notre API simulée, nous pouvons faire des demandes HTTP en utilisant Curl:

$ curl -X GET "http://localhost:3000/movies"

Cela renverra une liste de tous les films que vous avez sur ce serveur. Dans le cas ci-dessus, vous obtiendrez deux films. Maintenant, pour obtenir un film avec ID 1, spécifiez simplement l'ID à la fin de l'URI: http://localhost:3000/movies/1.

Pour ajouter un film au serveur, vous pouvez envoyer une demande postale à l'API avec les détails du film. Par exemple:

$ npm install -g json-server

Cela renverra de nouvelles données de film. Pour vérifier si l'enregistrement a été ajouté avec succès, essayons d'obtenir le film avec ID 3:

{
  "movies": [
    {"id": 1, "name": "The Godfather", "director":"Francis Ford Coppola", "rating": 9.1},
    {"id": 2, "name": "Casablanca", "director": "Michael Curtiz", "rating": 8.8}
  ]
}

De même, vous pouvez utiliser d'autres verbes HTTP tels que Put and Supprimer pour accéder et modifier des données sur ce serveur. Par convention, Post est utilisé pour créer de nouvelles entités, tandis que PUT est utilisé pour mettre à jour les entités existantes.

Remarque: les demandes de put, de publication et de correctif nécessitent un en-tête Content-Type: application/json.

Fonction

JSON-Server offre de nombreuses fonctionnalités utiles pour l'API Mock que vous devez construire manuellement sur le backend. Explorons certaines de ces fonctionnalités:

Filtre

Vous pouvez appliquer des filtres en les ajoutant à l'URI en tant que chaîne de requête. Par exemple, si vous souhaitez obtenir les détails d'un film intitulé "Casablanca", vous pouvez envoyer une demande GET à la ressource URI, ajouter un point d'interrogation (?), Puis le nom d'attribut que vous souhaitez filtrer et sa valeur:

$ json-server --watch db.json

Vous pouvez également combiner plusieurs filtres en ajoutant un '&' entre les filtres (& '). Par exemple, si nous voulons également filtrer par ID dans l'exemple ci-dessus, nous pouvons utiliser:

$ curl -X GET "http://localhost:3000/movies"

Opérateur

L'API

vous fournit également des opérateurs logiques pour faciliter le filtrage. Vous pouvez utiliser _gte et _lte comme supérieur et inférieur aux opérateurs. Vous avez également _ne pour exclure les valeurs de la réponse.

par exemple, si vous voulez tous les films avec une note supérieure ou égale à 9:

$ curl -X POST -H "Content-Type: application/json" -d '{
  "id": 3,
  "name": "Inception",
  "director": "Christopher Nolan",
  "rating": 9.0
}' "http://localhost:3000/movies"

Notez que vous pouvez combiner plusieurs opérateurs avec des nombres. Donc, pour obtenir tous les films avec des notes entre 5 et 7, vous ferez la demande suivante:

$ curl -X GET "http://localhost:3000/movies/3"

pagination

Dans le monde réel, vous traiterez de nombreuses données. Ces données peuvent être facilement chargées en petits morceaux en utilisant la prise en charge de pagination intégrée JSON-Server (fixe 10 éléments par page).

Par exemple, si vous souhaitez accéder à la page 3 de l'API du film, envoyez une demande de GET:

$ curl -X GET "http://localhost:3000/movies?name=Casablanca"

Cela reviendra aux articles 21-30.

tri

Vous pouvez utiliser les propriétés _sort et _order pour demander des données triées de l'API. Par exemple, si vous souhaitez que la liste des films soit triée en ordre décroissant par son nom (ordre alphabétique), vous enverrez la demande suivante:

$ curl -X GET "http://localhost:3000/movies?name=Casablanca&id=2"

JSON-Server offre de nombreuses autres fonctionnalités. Vous pouvez en savoir plus sur ces fonctions et les fonctions ci-dessus dans la documentation JSON-Server.

Générer des données de simulation pour votre API

Il n'est pas amusant d'utiliser presque aucune donnée dans l'API pour tester le frontal. Vous pouvez utiliser des modules comme Faker.js pour créer des exemples de données pour votre API simulée.

Installez le package avec la commande suivante:

$ curl -X GET "http://localhost:3000/movies?rating_gte=9"

Créez un fichier appelé fake-data-generator.js et entrez ce qui suit:

$ curl -X GET "http://localhost:3000/movies?rating_gte=5&rating_lte=7"

Ici, nous avons créé 1000 fausses entrées de film différentes, en utilisant Faker pour générer le titre de film et le nom du réalisateur. Le score est créé en générant un nombre aléatoire entre 1 et 100 et en le divisant par 10.

Pour créer un fichier db.json à l'aide de ce script, exécutez la commande suivante dans le terminal:

$ npm install -g json-server

Maintenant, vous avez une base de données de 1000 films. Vous avez maintenant beaucoup de fausses données qui peuvent être utilisées pour développer et / ou tester votre application.

Conclusion

Vous devriez maintenant être en mesure de créer rapidement votre propre API simulée et de lui ajouter des données de test. La bibliothèque JSON-Server vous permet de prototypifier rapidement le code frontal sans passer du temps (presque) à créer des frontaux.

Cet outil fera-t-il partie de votre flux de travail? Ou avez-vous d'autres moyens de l'utiliser avec succès? Veuillez partager vos pensées et suggestions dans les commentaires ci-dessous!

FAQ (FAQ) sur l'utilisation du serveur JSON pour simuler les API REST

Quels sont les principaux avantages de l'utilisation du serveur JSON pour simuler l'API REST?

JSON Server fournit un moyen simple et rapide de configurer de fausses API REST à des fins de développement et de test. Il permet aux développeurs de créer une API de repos complète avec des opérations CUD (créer, lire, mettre à jour, supprimer) en quelques minutes. Cela peut considérablement accélérer le processus de développement car il élimine la nécessité d'attendre que l'équipe backend développe l'API réelle. De plus, JSON Server utilise des fichiers JSON pour stocker les données, ce qui facilite la modification des données et de la structure de l'API.

Comment installer le serveur JSON?

JSON Server est un module Node.js, vous devez donc installer Node.js et NPM (Node Package Manager) sur votre système. Après avoir installé Node.js et NPM, vous pouvez installer JSON Server global sur votre système à l'aide des commandes suivantes dans l'invite de terminal ou de commande: npm install -g json-server.

Comment créer une API simulée à l'aide du serveur JSON?

Pour créer une API simulée à l'aide du serveur JSON, vous devez d'abord créer un fichier JSON qui agira comme votre base de données. Ce fichier doit contenir le numéro que vous souhaitez fournir via l'API

(En raison des limites de l'espace, le contenu FAQ ultérieur sera omis. Si nécessaire, veuillez poser des questions spécifiques.)

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!