MongoDB REST API を構築する

Bilal Shahid 2023年6月20日
  1. 残りの API
  2. MongoDB REST API を構築する
  3. アプリケーションの依存関係をインストールする
  4. MongoDB REST API アプリケーションを確立する
  5. MongoDB REST API エンドポイントを構築する
MongoDB REST API を構築する

MongoDB は、大量のデータ ストレージに広く使用されている、柔軟でスケーラブルなドキュメント指向のデータベース システムです。 テーブルと行を使用する従来の合理的なデータベース アプローチの代わりに、ドキュメントとコレクションを使用します。

サーバーはネイティブ バイナリ プロトコルを使用して効率を高めるため、MongoDB には本格的な REST インターフェイスはありません。 ただし、さまざまなアプリケーションで MongoDB REST API を作成できます。

残りの API

RESTful アプリケーション プログラミング インターフェイスとも呼ばれる REST API は、REST アーキテクチャ スタイルの制約に従います。 これにより、最終的に他のいくつかの RESTful Web サービスとの対話が可能になります。

この場合の REST は、representational state transfer を表します。 REST はプロトコルでも標準でもありませんが、開発者がさまざまな方法で REST を実装できるようにする一連のアーキテクチャ上の制約です。

API が REST 制約に準拠するには、前述の基準に従う必要があります。

  1. クライアントとサーバーの分離

    この特定の設計アプローチは、クライアントとサーバーを分離して個別に対応する必要があるという制約に基づいています。 ここで、クライアントとサーバー間の通信は、クライアントによって開始された要求と、サーバーによって応答として送信される応答に制限されます。

    これにより、サーバー コンポーネントが簡素化され、スケーラビリティと管理性が向上します。

  2. コードオンデマンド

    API は、この制約がなくても RESTful にすることができます。 ただし、プロセスには役立ちます。 これにより、事前に実装する必要のある機能の数が減ります。

  3. ステートレス

    REST API では、サーバーは API を使用するユーザーに関する情報を保持しません。つまり、ユーザーはステートレスです。 クライアントからサーバーに送信されるリクエストには、サーバーがクライアントのリクエストを理解し、それに従うために必要なすべての情報が含まれています。

  4. 統一されたインターフェース

    クライアントを切り離すために、REST API は統一されたインターフェースに準拠しています。 これにより、アプリケーションのモデル、サービス、または API 層に接続されたアクションをリンクすることなく、独立したアプリケーション開発が可能になります。

  5. レイヤード

    REST API のアーキテクチャには、スケーラブルで適応性のあるアプリケーションの作成に役立つ階層を作成するために連携する複数のレイヤーがあります。 サーバーの重要で影響を受けやすい要素をファイアウォールの背後に隠し、最終的にそれらとの直接的なやり取りを禁止します。

MongoDB REST API を構築する

時間の経過とともに、データベース テクノロジは高度になり、幅広い機能を提供しています。 同時に、一部のデータベース システムは、特定のデータを他のシステムよりも適切に処理します。

MongoDB は、大規模な非構造化データを処理する際に優れたスケーラビリティとパフォーマンスを備えたオープン ソース ソリューションです。

REST API を作成するときは、適切なデータベースを選択することが重要です。 MongoDB は、非構造化データに最適なドキュメントを取得および保存できるため、REST API の優れたオプションです。

MongoDB REST API が正常に開始されるようにするために最初にできることは、ワークスペースを準備することです。 ここでの最初のステップは、MongoDB インスタンスが動作していることを確認することです。

それが確認されると、MongoDB クライアントはサーバーに接続し、データをさらに検査したり、クエリを実行したりできます。

MongoDB REST API では、MongoDB データベースにデータを入力する必要があります。これは、mongo パッケージで実行できます。 このパッケージには、データベースのデータ ファイルをインポートできる mongoimport コマンドが含まれています。

このコマンド ラインを使用して、JavaScript Object Notation (JSON)、Comma-Separated Values (CSV)、および Tab-Separated Values (TSV) を含む 3 種類のデータ ファイルをインポートできます。

さらに、アプリを配置するためのアプリケーション フォルダーを作成する必要があります。すべてのノード アプリケーション メタデータを含むアプリケーションを起動するには、.json ファイル パッケージを生成する必要があります。

次に、ファイルは npm に指示して、パッケージの依存関係とアプリケーション スクリプトをインストールします。

REST API を構築するときは、バックエンド Web サーバーを使用することが不可欠です。 ドキュメント ストアのバックエンド サーバーとして Express JS を使用するのが、これを行う一般的な方法です。

この手法は、JSON ベースの REST API ペイロードを MongoDB のドキュメント モデルにリンクします。 Express を使用して、Node.js で実行されるバックエンド中間層を作成し、REST API ルートをアプリケーションに公開できるようにします。

さらに、Node.js ドライバーは MongoDB Atlas クラスターを Express.js サーバーに接続します。

MongoDB Atlas は、サインアップする必要があるクラウド データベースです。 これにより、MongoDB REST API の構築に集中できます。

アプリケーションの依存関係をインストールする

MongoDB REST API には、アプリケーション コマンド センターとしての役割を果たすファイルが必要です。 npm がアプリケーションを実行する必要がある場合、最初にファイルを実行します。

このコマンド センター ファイルには、インストールされたサードパーティ モジュールと、npm ディレクトリからインストールされた両方のモジュールを含めることができます。 依存関係は次のとおりです。

  1. MongoDB: MongoDB と Node.js アプリケーション間の通信を可能にする MongoDB の公式モジュール。
  2. Express: Node.js フレームワーク
  3. Body-parser: Express でリクエストボディを処理します

MongoDB REST API アプリケーションを確立する

MongoDB REST API に接続するには、接続文字列が必要です。

  1. Atlas ダッシュボードに移動し、Clusters を選択します。
  2. 概要ページに移動し、[接続] ボタンをクリックします。
  3. 文字列を .js ファイルに追加すると、コードを調整して接続を確立できます。

MongoDB REST API エンドポイントを構築する

さらに先に進むには、データのエンドポイントを確立してクエリを実行する必要があります。 データを追加するには、エンドポイントを構築する必要があります。

.js アプリケーションに API エンドポイント コードを追加して、REST API の作成を完了します。

MongoDB REST API は、適切な手順に従って比較的簡単にセットアップできます。 データを保存および取得できるため、非構造化データに最適です。

この記事が、MongoDB REST API とその構築方法について理解するのに役立つことを願っています。

著者: Bilal Shahid
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