Erstellen Sie eine MongoDB-REST-API

Bilal Shahid 20 Juni 2023
  1. REST-API
  2. Erstellen Sie eine MongoDB-REST-API
  3. Anwendungsabhängigkeiten installieren
  4. Richten Sie eine MongoDB-REST-API-Anwendung ein
  5. Erstellen Sie einen MongoDB-REST-API-Endpunkt
Erstellen Sie eine MongoDB-REST-API

MongoDB ist ein flexibles und skalierbares dokumentenorientiertes Datenbanksystem, das häufig für die Speicherung großer Datenmengen verwendet wird. Es verwendet Dokumente und Sammlungen anstelle des herkömmlichen rationalen Datenbankansatzes, der Tabellen und Zeilen verwendet.

MongoDB hat keine vollwertige REST-Schnittstelle, da der Server das native Binärprotokoll verwendet, um die Effizienz zu steigern. Verschiedene Anwendungen ermöglichen jedoch die Erstellung einer MongoDB-REST-API.

REST-API

Eine REST-API, auch bekannt als RESTful Application Programming Interface, hält sich an die Einschränkungen des REST-Architekturstils. Dies ermöglicht letztendlich die Interaktion mit mehreren anderen RESTful-Webdiensten.

REST steht in diesem Fall für Representational State Transfer. REST ist kein Protokoll oder Standard, sondern eine Reihe von architektonischen Einschränkungen, die es Entwicklern ermöglichen, es auf verschiedene Arten zu implementieren.

Damit eine API den REST-Einschränkungen entspricht, muss sie die genannten Kriterien erfüllen:

  1. Getrennter Client-Server

    Dieser spezifische Entwurfsansatz basiert auf der Einschränkung, dass Client und Server getrennt und unabhängig versorgt werden sollten. Dabei beschränkt sich die Kommunikation zwischen Client und Server auf die von den Clients initiierte Anfrage und die vom Server als Antwort gesendete Antwort.

    Dies verbessert die Skalierbarkeit sowie die Verwaltbarkeit, indem die Serverkomponente vereinfacht wird.

  2. Code auf Abruf

    Eine API kann auch ohne diese Einschränkung RESTful sein; es hilft jedoch dem Prozess. Es reduziert die Anzahl der Features, die vorab implementiert werden müssen.

  3. Staatenlos

    In REST-APIs speichert der Server keine Informationen über den Benutzer, der die API verwendet, was bedeutet, dass sie zustandslos sind. Die vom Client an den Server gesendeten Anfragen enthalten alle erforderlichen Informationen, um sicherzustellen, dass der Server die Anfrage des Clients versteht und erfüllt.

  4. Einheitliche Schnittstelle

    Um einen Client zu entkoppeln, entspricht die REST-API einer einheitlichen Schnittstelle. Dies ermöglicht eine unabhängige Anwendungsentwicklung, ohne die Modelle, Dienste oder Aktionen der Anwendung zu verknüpfen, die mit der API-Schicht verbunden sind.

  5. Geschichtet

    Die Architektur für eine REST-API hat mehrere Schichten, die zusammenarbeiten, um eine Hierarchie zu erstellen, die hilft, eine skalierbare und anpassbare Anwendung zu erstellen. Verstecken Sie die entscheidenden und anfälligeren Elemente des Servers hinter einer Firewall und verhindern Sie letztendlich die direkte Interaktion mit ihnen.

Erstellen Sie eine MongoDB-REST-API

Im Laufe der Zeit haben sich Datenbanktechnologien weiterentwickelt und bieten ein breites Spektrum an Möglichkeiten. Gleichzeitig arbeiten einige Datenbanksysteme besser mit bestimmten Daten als andere.

MongoDB ist eine Open-Source-Lösung mit besserer Skalierbarkeit und Leistung beim Umgang mit großen unstrukturierten Daten.

Bei der Erstellung einer REST-API ist es entscheidend, eine geeignete Datenbank auszuwählen. MongoDB ist eine großartige Option für Ihre REST-API, da es Dokumente abrufen und speichern kann, was es ideal für unstrukturierte Daten macht.

Das erste, was Sie tun können, um sicherzustellen, dass Ihre MongoDB-REST-API einen erfolgreichen Start hat, ist die Vorbereitung Ihres Arbeitsbereichs. Der erste Schritt hier besteht darin, sicherzustellen, dass Ihre MongoDB-Instanz betriebsbereit ist.

Sobald dies bestätigt ist, kann sich der MongoDB-Client mit dem Server verbinden und Ihre Daten weiter untersuchen oder Ihre Abfragen zusammen mit anderen Dingen ausführen.

Mit der MongoDB-REST-API muss die MongoDB-Datenbank gefüllt werden, was mit dem mongo-Paket erfolgen kann. Dieses Paket enthält den Befehl mongoimport, mit dem Sie Datendateien für Ihre Datenbank importieren können.

Über diese Befehlszeile können Sie drei verschiedene Arten von Datendateien importieren, darunter JavaScript Object Notation (JSON), Comma-Separated Values (CSV) und Tab-Separated Values (TSV).

Darüber hinaus müssen Sie einen Anwendungsordner erstellen, in dem sich die App befinden kann. Ein .json-Dateipaket muss generiert werden, um die Anwendung zu starten, die alle Anwendungsmetadaten des Knotens enthält.

Die Datei weist dann npm an, die Paketabhängigkeiten und die Anwendungsskripte zu installieren.

Beim Erstellen der REST-API ist es wichtig, einen Backend-Webserver zu verwenden. Die Verwendung von Express JS als Backend-Server für den Dokumentenspeicher ist eine gängige Methode, dies zu tun.

Diese Technik verknüpft die JSON-basierten REST-API-Nutzlasten mit dem Dokumentmodell von MongoDB. Verwenden Sie Express, um die Backend-Middle-Tier zu erstellen, die auf Node.js läuft und es ermöglicht, REST-API-Routen für Ihre Anwendung verfügbar zu machen.

Zudem verbindet der Node.js-Treiber den MongoDB-Atlas-Cluster mit dem Express.js-Server.

MongoDB Atlas ist eine Cloud-Datenbank, für die Sie sich anmelden müssen. Damit können Sie sich auf die Erstellung Ihrer MongoDB-REST-API konzentrieren.

Anwendungsabhängigkeiten installieren

Die MongoDB-REST-API erfordert eine Datei, die ihrer Rolle als Anwendungs-Befehlszentrale dient. Wenn npm die Anwendung ausführen muss, führt es zunächst die Datei aus.

Diese Command-Center-Datei kann installierte Module von Drittanbietern und Ihre beiden installierten Module aus dem Verzeichnis npm enthalten. Die Abhängigkeiten sind die folgenden:

  1. MongoDB: Das offizielle Modul für MongoDB, das die Kommunikation zwischen MongoDB- und Node.js-Anwendungen ermöglicht.
  2. Express: Node.js-Framework
  3. Body-Parser: Verarbeitet Anfragetexte mit Express

Richten Sie eine MongoDB-REST-API-Anwendung ein

Sie benötigen eine Verbindungszeichenfolge, um eine Verbindung mit der MongoDB-REST-API herzustellen.

  1. Gehen Sie zum Atlas-Dashboard und wählen Sie Cluster.
  2. Gehen Sie auf die Übersichtsseite und klicken Sie auf die Schaltfläche Verbinden.
  3. Fügen Sie die Zeichenfolge Ihrer .js-Datei hinzu, und Sie können mit einigen Code-Anpassungen eine Verbindung herstellen.

Erstellen Sie einen MongoDB-REST-API-Endpunkt

Um fortzufahren, müssen Sie Endpunkte für Ihre Daten einrichten und abfragen. Sie müssen einen Endpunkt erstellen, um Daten hinzuzufügen.

Fügen Sie Ihrer .js-Anwendung den API-Endpunktcode hinzu, um die Erstellung der REST-API abzuschließen.

Die MongoDB-REST-API ist mit den richtigen Anweisungen relativ einfach einzurichten. Es ermöglicht Ihnen das Speichern und Abrufen von Daten, was es perfekt für unstrukturierte Daten macht.

Wir hoffen, dass dieser Artikel Ihnen dabei geholfen hat, MongoDB-REST-APIs und deren Erstellung zu verstehen.

Bilal Shahid avatar Bilal Shahid avatar

Hello, I am Bilal, a research enthusiast who tends to break and make code from scratch. I dwell deep into the latest issues faced by the developer community and provide answers and different solutions. Apart from that, I am just another normal developer with a laptop, a mug of coffee, some biscuits and a thick spectacle!

GitHub