Codieren Sie Ihre erste API mit Node.js und Express: Richten Sie den Server ein

Im vorherigen Tutorial haben wir etwas über die Restarchitektur, die sechs Einschränkungen der Ruhe, die Verständnis der HTTP -Anforderungsmethode und dessen Antwortcode und die Komposition des RESTful -API -Endpunkts erfahren.

In diesem Tutorial wird ein Server für unsere API eingerichtet. Sie können APIs mit jeder Programmiersprache und Server -Software erstellen.

Installieren

Unsere erste Prämisse besteht darin, sicherzustellen, dass Node.js und NPM weltweit auf dem Computer installiert werden. Wir können beide mit express-api testen und darauf wechseln.

 mkdir express-api && cd express-api

Nachdem wir uns im neuen Verzeichnis befinden, können wir unser Projekt zusammen mit jeder Abhängigkeit mit den Installationsbefehlen initialisieren, um das Projekt -Setup abzuschließen.

 NPM Installation Body-Parser Express MySQL Anfrage

Dadurch wird eine package-lock.json Datei und ein node_modules -Verzeichnis erstellt, und unser package.json wird so aktualisiert, dass sie so aussehen:

 {
  "Name": "Express-App",
  "Version": "1.0.0",
  "Beschreibung": "",
  "Main": "Index.js",
  "Autor": "Asyncbanana",
  "Lizenz": "MIT",
  "Abhängigkeiten": {{
    "Body-Parser": "^1.19.2",
    "Express": "^4.17.3",
    "MySQL": "^2.18.1",
    "Knotenfetch": "^3.2.0"
  }
}

Dann müssen wir das Objekt "Skripte" hinzufügen. Das Objekt "Skripte" kann uns helfen, den Code auszuführen.

 {
  "Name": "Express-App",
  "Version": "1.0.0",
  "Beschreibung": "",
  "Main": "Index.js",
  "Skripte": {{
    "Start": "Node Index.js"
  },
  "Autor": "Asyncbanana",
  "Lizenz": "MIT",
  "Abhängigkeiten": {{
    "Body-Parser": "^1.19.2",
    "Express": "^4.17.3",
    "MySQL": "^2.18.1",
    "Knotenfetch": "^3.2.0"
  },
  "Typ": "Modul"
}

Was ist ein ECMascript -Modul?

Das ECMascript -Modul (oder ESM) ist eine neue Spezifikation zum Verbinden von Skripten in Umgebungen wie Browsern und Knoten. Es ersetzt alte Spezifikationen wie CommonJs (CJS), die standardmäßig von Knoten verwendet werden. In diesem Tutorial werden wir alle ESMs verwenden.

Richten Sie einen HTTP -Server ein

Bevor wir den Express-Server einrichten, verwenden wir das integrierte http Modul des Knotens, um einen HTTP-Server schnell einzurichten und eine Portnummer festzulegen (ich habe createServer() ausgewählt).

 // Erstellen Sie den Server mit dem HTTP -Modul des Knotens import {createServer} aus "http";
const port = 3001;
const server = createServer ();

Im Einführungs -Ruheartikel diskutieren wir Anfragen und Antworten zu HTTP -Servern. Wir werden unseren Server so einrichten, dass die Anforderung verarbeitet, die angeforderte URL auf der Serverseite angezeigt wird und die "Hallo, Server!"

 server.on ("Anfrage", (Anfrage, Antwort) => {
    console.log (`url: $ {request.url}`);
    Antwort.end ("Hallo, Server!");
});

Schließlich werden wir dem Server mitteilen, welchen Port er anhört und einen Fehler anzeigen soll, wenn er angezeigt wird.

 // Starten Sie den Server server.listen (Port, (Fehler) => {
    if (Fehler) return console.log (`error: $ {error}`);
    console.log (`Server hört auf Port $ {port}`);
});

Jetzt können wir den Server starten, indem wir das zuvor erstellte NPM -Skript ausführen.

 NPM Start

Sie werden diese Antwort im Terminal sehen:

 <code>Server is listening on port 3001</code>

Um zu überprüfen, ob der Server ausgeführt wird, besuchen Sie https://localhost:3001/hello und Sie sehen die GET -Anforderung im Server -Root -Verzeichnis ( / empfangen Sie die Anfrage, wir werden die angeforderte URL und die "Hallo, Server!" Angezeigt.

 App.get ("/", (Anfrage, Antwort) => {
    console.log (`url: $ {request.url}`);
    Antwort.Send ("Hallo, Server!");
});

Schließlich starten wir den Server auf dem Port listen() -Methode.

 const server = app.listen (port, (error) => {
    if (Fehler) return console.log (`error: $ {error}`);
    console.log (`server hör auf port $ {server.address (). port}`);
});

Jetzt können wir curl -i für die URL verwenden, wir werden sehen, dass sie jetzt von Express angetrieben wird und es einige zusätzliche Header wie POST und body-parser -Module gibt. Fügen Sie die import zum oberen Rand der index.js -Datei hinzu.

 Bodyparser aus "Body-Parser" importieren;
...

Dann werden wir unsere Express -Anwendung mit curl -i zum Server mitteilen und Sie sehen, dass der Header nun zurückgeht, um zum Stammverzeichnis zu GET ( .js ist in require nicht erforderlich. Jetzt verschieben wir den Router der Anwendung, damit wir sie in der index.js -Datei verwenden können.

 // Router exportieren aus dem Standard -Router;

Ersetzen Sie in index.js die Route:

 Routen (App);

Sie sollten nun in der Lage sein, die users in routes.js zu erhalten, die einige gefälschte Benutzerdaten im JSON -Format enthalten.

 const user = [
  {
    ID: 1,
    Name: "Richard Hendricks",
    E -Mail: "richard@piedpiper.com",
  },
  {
    ID: 2,
    Name: "Bertram Gilfoyle",
    E -Mail: "gilfoyle@piedpiper.com",
  },
];

Wir werden einen weiteren /users hinzufügen und Benutzerdaten darüber senden.

 app.get ("/user", (request, response) => {
    Antwort.Send (Benutzer);
});

Nach dem Neustart des Servers können Sie jetzt zu http://localhost:3002/users navigieren und alle von uns angezeigten Daten anzeigen.

Hinweis: Wenn Sie keine JSON -Viewer -Erweiterung in Ihrem Browser haben, empfehle ich Ihnen dringend, eine herunterzuladen, z. B. Chrome's JSONVUE. Dadurch wird die Daten leichter zu lesen!

Besuchen Sie unser Github -Repository, um den vollständigen Code dieses Artikels anzuzeigen und mit Ihrem eigenen zu vergleichen.

abschließend

In diesem Tutorial haben wir gelernt, wie man einen integrierten HTTP-Server und einen Express-Server im Knoten, Routenanforderungen und URLs eingerichtet und GET-Anforderungen zur Verwendung von JSON-Daten verwenden.

In der endgültigen Ausgabe der erholsamen API -Serie verbinden wir unseren Express -Server mit MySQL, um Benutzer in der Datenbank zu erstellen, anzeigen, zu aktualisieren und zu löschen, um die Funktionalität der API zu vervollständigen.

Das obige ist der detaillierte Inhalt vonCodieren Sie Ihre erste API mit Node.js und Express: Richten Sie den Server ein. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!