Holen Sie sich eine gefälschte REST-API mit JSON-Server zum Laufen

In diesem Tutorial sehen Sie, wie Sie mit dem Einrichten und Verwenden eines gefälschten REST-API-Servers mit JSON-Server beginnen, den Sie bei der Entwicklung mobiler oder Webanwendungen verwenden können. In diesem Tutorial geht davon aus, dass Sie grundlegende Kenntnisse über JSON- und HTTP -Anfragen haben.

Was ist Ruhe?

Ruhe steht für Repräsentationsstaatenübertragung. Es ist ein Architekturstil für die Gestaltung verbundener Anwendungen. Es verwendet einfaches HTTP, um die Kommunikation zwischen Maschinen zu ermöglichen. Anstatt eine URL zum Manipulieren einiger Benutzerinformationen zu verwenden, sendet Rest eine HTTP -Anfrage wie GET, Post, Löschen usw. an eine URL, um Daten zu manipulieren.

Anstatt beispielsweise eine GET -Anfrage an eine URL wie /deleteuser?id=10 zu stellen, würde die Anfrage wie DELETE /user/10 sein.

Warum brauchen wir eine gefälschte REST -API?

REST -APIS BESUCHEN Sie das Back -End für mobile und Webanwendungen. Bei der Entwicklung von Anwendungen haben Sie manchmal nicht die Rest -APIs bereit, für Entwicklungszwecke verwendet zu werden. Um die mobile oder Web -App in Aktion anzuzeigen, benötigen wir einen Server, der einige Dummy -JSON -Daten ausgibt.

Dann kommt die gefälschte REST -API ins Bild. json-server bietet die Funktionalität, einen gefälschten REST-API-Server mit minimaler Aufwand einzurichten.

Erste Schritte

Um mit json-server zu beginnen, installieren Sie das Paket mit dem Node Package Manager (NPM).

 NPM install -g json -server<br>

Erstellen Sie eine Dummy -JSON -Datei mit einigen Daten gemäß Ihrer Anforderung. Zum Beispiel benötige ich einige JSON -Daten mit Benutzerinformationen wie ID, Name, Speicherort usw., also erstelle ich eine Datei namens info.json mit den folgenden JSON -Informationen:

 {<br> "Benutzer": [{{<br> "id": 1,,<br> "Name": "Roy",<br> "Ort": "Indien"<br> }, {<br> "id": 2,<br> "Name": "Sam",<br> "Ort": "Wales"<br> }]<br> }<br>

Führen Sie den JSON -Server aus dem Terminal mit info.json als Datenquelle aus, und Sie sollten die REST -API unter http: // localhost: 3000 ausführen lassen.

 JSON-Server info.json<br>

Testen der Rest -API -Endpunkte

Da unser gefälschter REST -API -Server in Betrieb ist, sehen wir uns an, wie Sie mit einem Client auf die Rest -API zugreifen können. Ich benutze den Postman -REST -Client, um die API -Anrufe zu tätigen.

Anfrage erhalten

Beginnen wir zunächst eine GET an die Rest -URL. In der JSON -Datei haben wir einen users definiert, der Informationen zu Benutzern enthält. Bei einer GET -Anfrage an die URL http: // localhost: 3000/Benutzer sollte die vorhandenen Daten angezeigt werden.

Postanfrage

Um den vorhandenen Daten neue Daten hinzuzufügen, werden wir der URL http: // localhost: 3000/user eine POST stellen. So würde die POST aussehen:

Versuchen Sie, eine GET -Anfrage zu erstellen, und Sie sollten die neu hinzugefügten Daten in der Datei info.json haben.

 [<br> {<br> "id": 1,,<br> "Name": "Roy",<br> "Ort": "Indien"<br> },<br> {<br> "id": 2,<br> "Name": "Sam",<br> "Ort": "Wales"<br> },<br> {<br> "Name": "II",<br> "Ort": "la",<br> "ID": 7<br> },<br> {<br> "Name": "Shona",<br> "Ort": "la",<br> "ID": 8<br> },<br> {<br> "Name": "Shona",<br> "Ort": "la",<br> "ID": 9<br> }<br> ]<br>

Anfrage löschen

Um einen Eintrag aus den json-server -Daten zu löschen, müssen Sie eine DELETE an den API-Endpunkt mit der Benutzer-ID senden. Um den Benutzer mit ID 1 zu löschen, müssen Sie beispielsweise eine DELETE an den Endpunkt http: // localhost: 3000/user/1 senden. Sobald es gelöscht wurde, versuchen Sie eine GET -Anfrage, und der Benutzer mit ID 1 sollte nicht im zurückgegebenen JSON sein.

Patch -Anfrage

Um einen vorhandenen Eintrag zu aktualisieren, müssen Sie eine PATCH -Anfrage mit den Details senden, die für diesen bestimmten Eintrag aktualisiert werden müssen. Um beispielsweise die Details für einen Benutzer mit ID 2 zu aktualisieren, senden wir eine PATCH -Anfrage an die URL http: // localhost: 3000/user/us wie gezeigt:

Durchsuchen von JSON-Server-REST-APIs

Mit json-server Rest-APIs können Sie die Daten durchsuchen, um Daten basierend auf bestimmten Kriterien zu finden. Um beispielsweise Benutzer mit einem bestimmten Namen zu finden, müssen Sie wie gezeigt eine GET -Anfrage an die REST -API -URL senden:

Wie im obigen Bild zu sehen ist, wird eine GET -Anfrage an die URL http: // localhost: 3000/user? Name = shona mit dem Namen Shona zurückgeben. Um mit allen anderen Feldern nach Benutzern zu suchen, müssen Sie dieses Feld der Abfragezeichenfolge hinzufügen.

Um eine Volltextsuche über den REST -API -Endpunkt auszuführen, müssen Sie die Suchzeichenfolge zusammen mit dem Parameter q zum Endpunkt hinzufügen. Um beispielsweise nach Benutzern mit Informationen zu suchen, die Suchzeichenfolge s enthalten, würde die Anfrage wie folgt aussehen:

Umgang mit Pagination

Bei der Anzeige eines paginierten Datenrasters wäre es erforderlich, einige Daten basierend auf Pagination abzurufen. In solchen Szenarien bietet json-server die Funktionalität, die JSON-Daten zu pagieren. Standardmäßig beträgt die Anzahl der von json-server zurückgegebenen Daten 10. Wir können diese Grenze mit dem Parameter _limit explizit definieren.

 http: // localhost: 3000/user? _limit = 5<br>

Eine Get -Anfrage an die oben genannte URL würde fünf Datensätze zurückgeben. Um die Daten zu paginieren, müssen wir der URL einen weiteren Parameter _page hinzufügen. _page definiert die Seite, die bei der Rückgabe der Daten abgerufen werden muss.

 http: // localhost: 3000/user? _limit = 5 & _page = 2<br>

Eine GET -Anfrage an die obige URL würde die zweite Seite des Datensatzes mit fünf Datensätzen pro Seite zurückgeben. Durch Ändern der _page -Variablen können wir die erforderlichen Seitendatensätze abrufen.

Handlingssorten

json-server bietet die Funktionalität zur Sortierung der abgerufenen Daten. Wir können die Daten sortieren, indem wir den Spaltennamen angeben, der sortiert werden muss, und die Reihenfolge, in der die Daten sortiert werden müssen. Standardmäßig werden die Daten in aufsteigender Reihenfolge sortiert. Wir können den Spaltennamen in der Endpunkt -URL mit dem Schlüsselwort _sort angeben und die Reihenfolge mit dem Schlüsselwort _order definieren. Hier ist eine Beispiel -URL:

 http: // localhost: 3000/user? _sort = id & _order = desc<br>

Die obige URL würde die Daten basierend auf der Spalten Id sortieren und in absteigender Reihenfolge sortiert.

Handhabungsbetreiber

json-server bietet auch die Funktionalität, um Operatoren zu unterstützen, wie das Finden eines Eintrags mit einer ID in einem Bereich zwischen zwei Werten oder einem Eintrag, der einem bestimmten regulären Ausdruck entspricht.

Um einen Eintrag innerhalb eines bestimmten Bereichs zu finden, können wir die _gte und _lte -Operatoren verwenden. Um beispielsweise Benutzer mit ID von mehr als 3 und weniger als 5 zu finden, stellen Sie eine Get -Anfrage an die URL http: // localhost: 3000/user? Id_gte = 3 & id_lte = 5 Wie gezeigt:

Wenn wir nach Namen suchen, die mit einem bestimmten Brief beginnen, können wir reguläre Ausdrücke verwenden. Um beispielsweise nach Namen zu suchen, beginnend mit den Buchstaben sa , werden wir den _like Operator verwenden und eine GET -Anfrage an die URL http: // localhost: 3000/user? Name_like =^sa stellen.

Abschluss

In diesem Tutorial haben Sie gesehen, wie Sie mit json-server -REST-APIs eine Dummy-Datenbank zur schnellen Verwendung erstellen. Sie haben gelernt, wie man mit json-server beginnt und die URL zum Hinzufügen, Aktualisieren, Ändern und Löschen von Daten abfragt. Sie haben gesehen, wie man die Dummy -Daten paginiert, sortiert und durchsucht. Sie haben auch gesehen, wie Sie Operatoren verwenden, um mit regelmäßigen Ausdrücken nach Einträgen zu suchen.

Haben Sie json-server oder einen anderen gefälschten REST-API-Server für die Erstellung von Dummydaten verwendet? Wie war deine Erfahrung? Lassen Sie uns Ihre Gedanken im Envato -Forum wissen.

Das obige ist der detaillierte Inhalt vonHolen Sie sich eine gefälschte REST-API mit JSON-Server zum Laufen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!