Schneller Tipp: Mock REST-APIs mit JSON-Server

Können Sie Front-End-Anwendungen ohne Back-End schnell prototypifizieren? Das Erstellen der grundlegendsten Simulations-API kann zeitaufwändig und arbeitsintensiv sein. Die JSON-Server-Bibliothek löst dieses Problem, indem sie eine schnelle und einfache Möglichkeit bietet, komplexe erholsame APIs für die Entwicklung und Prüfung zu erstellen.

Mit diesem schnellen Tipp können Sie mit JSON-Server eine Mock-Rast-API erstellen, mit der Sie in nur 30 Sekunden eine API mit vollem Funktionsumfang in Betrieb nehmen können.

Schlüsselpunkte

• JSON-Server-Bibliothek kann verwendet werden, um schnell komplexe APIs für die Entwicklung und das Testen zu erstellen, sodass Entwickler das vordere Ende ihrer Anwendungen ohne Backend prototypisieren können.
• JSON-Server bietet Funktionen wie Filter, logische Operatoren, Paging und Sortierung, mit denen Schein-APIs erstellt werden können, mit denen Frontendungen mit einer großen Menge gefälschter Daten getestet werden können.
• Mit dem faker.js -Modul können Entwickler Scheindaten für die API generieren, wodurch der Entwicklungs- und Testprozess effizienter und näher an der tatsächlichen Situation wird.

Vorsichtsmaßnahmen

Sie sollten das erholsame Prinzip und die Grundkenntnisse über die Verwendung der API haben.

Sie benötigen die folgenden Tools:

• nodeJS - JSON -Server basiert auf NodeJs.
• curl - Wird verwendet, um das Routing des simulierten Servers zu testen.

Windows-Benutzer: Die Curl-Download-Seite enthält 32-Bit- und 64-Bit-Versionen von Curl-Binärdateien, mit denen Sie die Beispiele in diesem Artikel kennenlernen können.

In diesem Tutorial wird davon ausgegangen, dass Sie ein bash-ähnliches Terminal verwenden.

Installation

Um JSON-Server zu installieren, öffnen Sie bitte Ihr Terminal und geben Sie ein:

$ npm install -g json-server

Dies wird json-server weltweit in Ihrem System installiert, damit Sie den Server aus jedem Verzeichnis starten können, das Ihnen gefällt.

Ressourcen

In der erholsamen API ist eine Ressource ein Objekt mit einem Typ, zugeordneten Daten, Beziehungen zu anderen Ressourcen und einer Reihe von Methoden, um darauf zu arbeiten. Wenn Sie beispielsweise eine API für einen Film erstellen, ist ein Film eine Ressource. Sie können Ihre API verwenden, um CRUD -Operationen auf diese Ressource anzuwenden.

Erstellen wir eine API mit /movies Ressourcen.

Ressourcen erstellen

Erstellen Sie eine Datei mit dem Namen db.json und fügen Sie Folgendes hinzu:

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

Starten Sie nach dem Speichern der Datei den Server mit dem folgenden Befehl:

$ json-server --watch db.json

Das ist es! Jetzt haben Sie eine Film -API.

Um unsere Mock -API zu testen, können wir HTTP -Anforderungen mit Curl:

stellen

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

Dies gibt eine Liste aller Filme zurück, die Sie auf diesem Server haben. Im obigen Fall erhalten Sie zwei Filme. Wenn Sie nun einen Film mit ID 1 erhalten, geben Sie einfach die ID am Ende des URI an: http://localhost:3000/movies/1.

Um dem Server einen Film hinzuzufügen, können Sie eine Postanforderung an die API mit Filmdetails senden. Zum Beispiel:

$ npm install -g json-server

Dies gibt neue Filmdaten zurück. Um zu überprüfen, ob der Datensatz erfolgreich hinzugefügt wurde, versuchen wir, den Film mit ID 3:

zu bekommen

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

In ähnlicher Weise können Sie andere HTTP -Verben wie Put und Löschen verwenden, um auf diesen Server auf Daten zuzugreifen und zu ändern. Nach Konvention wird Post verwendet, um neue Einheiten zu erstellen, während Put zur Aktualisierung vorhandener Entitäten verwendet wird.

HINWEIS: Stellen Sie, Post- und Patch -Anfragen einen Content-Type: application/json -Header benötigen.

Funktion

json-server bietet viele nützliche Funktionen für die Schein-API, die Sie im Backend manuell bauen müssen. Erforschen wir einige dieser Funktionen:

filter

Sie können Filter anwenden, indem Sie sie als Abfragezeichenfolge an die URI anhängen. Wenn Sie beispielsweise die Details eines Films namens "Casablanca" erhalten möchten, können Sie eine Get -Anfrage an die Ressourcen -URI senden, ein Fragezeichen (?) Und dann den Attributnamen, den Sie filtern möchten, und dessen Wert anhängen:

$ json-server --watch db.json

Sie können auch mehrere Filter kombinieren, indem Sie ein "&" zwischen den Filtern (& ') hinzufügen. Wenn wir beispielsweise im obigen Beispiel auch nach ID filtern möchten, können wir:

verwenden

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

Operator

Die

API bietet Ihnen auch logische Operatoren, um die Filterung zu vereinfachen. Sie können _gte und _lte als größer als und weniger als Operatoren verwenden. Sie haben auch _ne, um Werte aus der Antwort auszuschließen.

Zum Beispiel, wenn Sie alle Filme mit einer Bewertung über 9 oder gleich 9:

wünschen

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

Beachten Sie, dass Sie mehrere Operatoren mit Zahlen kombinieren können. Um alle Filme mit Bewertungen zwischen 5 und 7 zu bekommen, werden Sie die folgende Anfrage stellen:

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

Pagination

In der realen Welt werden Sie viele Daten verarbeiten. Diese Daten können leicht in kleine Stücke unter Verwendung eines integrierten JSON-Server-Pagination-Supports (feste 10 Elemente pro Seite) geladen werden.

Wenn Sie beispielsweise auf Seite 3 der Film -API zugreifen möchten, senden Sie eine Get -Anfrage:

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

Dies kehrt zu den Punkten 21-30 zurück.

sortieren

Sie können die Eigenschaften _sort und _order verwenden, um sortierte Daten aus der API anzufordern. Wenn Sie beispielsweise möchten, dass die Filmliste in absteigender Reihenfolge nach Namen (alphabetische Reihenfolge) sortiert wird, senden Sie die folgende Anfrage:

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

JSON-Server bietet viele andere Funktionen. Sie können mehr über diese und die oben genannten Funktionen in der JSON-Server-Dokumentation erfahren.

Simulationsdaten für Ihre API

generieren

Es macht keinen Spaß, in der API fast keine Daten zu verwenden, um das Front-End zu testen. Sie können Module wie faker.js verwenden, um einige Beispieldaten für Ihre Mock -API zu erstellen.

installieren Sie das Paket mit dem folgenden Befehl:

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

Erstellen Sie eine Datei namens fake-data-generator.js und geben Sie Folgendes ein:

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

Hier haben wir 1000 verschiedene gefälschte Filmeinträge erstellt und Faker verwendet, um den Filmtitel und den Namen des Regisseurs zu generieren. Die Punktzahl wird erstellt, indem eine Zufallszahl zwischen 1 und 100 generiert und um 10 geteilt wird.

Um eine db.json Datei mit diesem Skript zu erstellen, führen Sie den folgenden Befehl im Terminal aus:

$ npm install -g json-server

Jetzt haben Sie eine Datenbank mit 1000 Filmen. Sie haben jetzt viele gefälschte Daten, mit denen Sie Ihre Anwendung entwickeln und/oder testen können.

Schlussfolgerung

Sie sollten jetzt in der Lage sein, schnell Ihre eigene Schein -API zu erstellen und Testdaten hinzuzufügen. Mit der JSON-Server-Bibliothek können Sie Front-End-Code schnell prototypifizieren, ohne (fast) Frontends zu erstellen.

Wird dieses Tool ein Teil Ihres Workflows? Oder haben Sie andere Möglichkeiten, es erfolgreich zu nutzen? Bitte teilen Sie Ihre Gedanken und Vorschläge in den Kommentaren unten mit!

FAQs (FAQs) zur Verwendung von JSON -Server, um REST -APIs zu simulieren

Was sind die Hauptvorteile der Verwendung von JSON -Server zur Simulation von REST -API?

JSON Server bietet eine einfache und schnelle Möglichkeit, gefälschte REST -APIs für Entwicklung und Testzwecke einzurichten. Es ermöglicht Entwicklern, eine vollständige REST -API mit CRUD (Erstellen, Lesen, Aktualisieren, Löschen) in Minuten zu erstellen. Dies kann den Entwicklungsprozess erheblich beschleunigen, da es die Notwendigkeit beseitigt, dass das Backend -Team die tatsächliche API entwickelt. Darüber hinaus verwendet JSON Server JSON -Dateien, um Daten zu speichern, wodurch die Daten und Struktur der API leicht geändert werden können.

Wie installiere ich JSON -Server?

JSON Server ist ein Node.js -Modul, daher müssen Sie Node.js und NPM (Node Package Manager) in Ihrem System installieren. Nach der Installation von node.js und npm können Sie JSON Server auf Ihrem System global installieren, indem Sie die folgenden Befehle in der Terminal- oder Eingabeaufforderung verwenden: npm install -g json-server.

Wie erstelle ich eine Mock -API mit JSON Server?

Um eine Mock -API mit JSON -Server zu erstellen, müssen Sie zunächst eine JSON -Datei erstellen, die als Datenbank fungiert. Diese Datei sollte die Nummer enthalten, die Sie über die API

zur Verfügung stellen möchten

(aufgrund von Platzbeschränkungen werden nachfolgende FAQ -Inhalte weggelassen. Bei Bedarf stellen Sie bitte bestimmte Fragen.)

Das obige ist der detaillierte Inhalt vonSchneller Tipp: Mock REST-APIs mit JSON-Server. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!