MongoDB を使用して単純な CRUD API を開発する方法

MongoDB を使用して単純な CRUD API を開発する方法

現代の Web アプリケーション開発では、CRUD (追加、削除、変更、クエリ) 操作が非常に一般的かつ重要です。機能1。この記事では、MongoDB データベースを使用して簡単な CRUD API を開発する方法と、具体的なコード例を紹介します。

MongoDB は、データをドキュメントの形式で保存するオープンソースの NoSQL データベースです。従来のリレーショナル データベースとは異なり、MongoDB には事前定義されたスキーマがないため、データ ストレージとクエリがより柔軟になります。したがって、MongoDB は、大量の非構造化データの保存と処理に最適です。

CRUD API を開発する前に、MongoDB が正しくインストールされ、構成されていることを確認する必要があります。 MongoDB の最新バージョンを公式 MongoDB Web サイトからダウンロードしてインストールし、公式ガイドに従って設定できます。

次に、Node.js と Express.js を使用して CRUD API を開発します。 Node.js がインストールされていること、および基本的な Node.js および Express.js 開発に精通していることを確認してください。はじめましょう！

ステップ 1: プロジェクトの初期化
まず、新しい Node.js プロジェクトを作成し、package.json ファイルを初期化します。コマンド ラインで次のコマンドを実行します。

$ mkdir crud-api
$ cd crud-api
$ npm init -y

これにより、crud-api という名前の新しいディレクトリが作成され、その中に新しい Node.js プロジェクトが初期化されます。 -y オプションは、デフォルト設定を使用して package.json ファイルを作成します。

ステップ 2: 依存関係をインストールする
CRUD API の開発に役立ついくつかの npm パッケージを使用します。コマンド ラインで次のコマンドを実行して依存関係をインストールします。

$ npm install express body-parser mongoose

これにより、npm を使用して express、body-parser、および mongoose がインストールされます。バッグ。 express は人気のある Node.js フレームワーク、body-parser はリクエスト本文を解析するミドルウェア、mongoose は MongoDB との対話に使用されるオブジェクトです。データベースモデルツール。

ステップ 3: サーバーとルーティングの作成
プロジェクトのルート ディレクトリで、server.js ファイルを作成し、次のコードを追加します:

const express = require('express');
const bodyParser = require('body-parser');
const mongoose = require('mongoose');

const app = express();
const port = 3000;

// 连接MongoDB数据库
mongoose.connect('mongodb://localhost:27017/crud-api', { useNewUrlParser: true });
const db = mongoose.connection;
db.on('error', console.error.bind(console, '数据库连接失败：'));
db.once('open', () => {
  console.log('数据库连接成功！');
});

// 设置路由
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());

app.get('/', (req, res) => {
  res.send('欢迎使用CRUD API');
});

// 启动服务器
app.listen(port, () => {
  console.log('服务器已启动，端口号：' + port);
});

Thisこのコードでは、まず必要な npm パッケージを導入し、次に Express アプリケーションを作成し、サーバー ポートを 3000 に設定します。その後、mongoose.connect() メソッドを使用して MongoDB データベースに接続します。 MongoDB サービスがローカル マシンのデフォルト ポート 27017 で実行されていることを確認してください。次に、主にテスト用にルート ルートを設定します。最後に、app.listen() メソッドを使用してサーバーを起動し、ポート 3000 でリッスンします。

ステップ 4: モデルとルーティングを定義する
product という名前の単純なデータベース モデルを作成し、対応する CRUD ルーティングを作成します。次のコードを server.js ファイルに追加します。

const Product = require('./models/product');

// 查询所有产品
app.get('/api/products', (req, res) => {
  Product.find({}, (err, products) => {
    if (err) {
      res.status(500).send('查询数据库出错！');
    } else {
      res.json(products);
    }
  });
});

// 查询单个产品
app.get('/api/products/:id', (req, res) => {
  Product.findById(req.params.id, (err, product) => {
    if (err) {
      res.status(500).send('查询数据库出错！');
    } else if (!product) {
      res.status(404).send('找不到产品！');
    } else {
      res.json(product);
    }
  });
});

// 创建新产品
app.post('/api/products', (req, res) => {
  const newProduct = new Product(req.body);
  newProduct.save((err, product) => {
    if (err) {
      res.status(500).send('保存到数据库出错！');
    } else {
      res.json(product);
    }
  });
});

// 更新产品
app.put('/api/products/:id', (req, res) => {
  Product.findByIdAndUpdate(req.params.id, req.body, { new: true }, (err, product) => {
    if (err) {
      res.status(500).send('更新数据库出错！');
    } else if (!product) {
      res.status(404).send('找不到产品！');
    } else {
      res.json(product);
    }
  });
});

// 删除产品
app.delete('/api/products/:id', (req, res) => {
  Product.findByIdAndRemove(req.params.id, (err, product) => {
    if (err) {
      res.status(500).send('删除数据库出错！');
    } else if (!product) {
      res.status(404).send('找不到产品！');
    } else {
      res.send('产品删除成功！');
    }
  });
});

このコードでは、最初に Product モデルを導入します。これは に基づくモデルです。 mongoose .Schema の単純な MongoDB モデル。次に、すべての製品のクエリ、単一の製品のクエリ、新しい製品の作成、製品の更新、および製品の削除のルートを定義しました。各ルートでは、対応する mongoose メソッドを使用して MongoDB データベースと対話し、返された結果に基づいて適切な応答を送信します。

ステップ 5: モデルを定義する
プロジェクトのルート ディレクトリに models ディレクトリを作成し、その中に product.js ファイルを作成します。次のコードを product.js ファイルに追加します。

const mongoose = require('mongoose');

const productSchema = new mongoose.Schema({
  name: String,
  price: Number,
  description: String
});

const Product = mongoose.model('Product', productSchema);

module.exports = Product;

このコードは、名前 name という文字列属性を持つ単純な製品モデル Product を定義します。 という名前の属性、price という名前の数値属性、および description という名前の文字列属性。 productSchema モデルをパラメータとして mongoose.model() メソッドに渡し、Product をエクスポートします。

ステップ 6: サーバーを実行します
プロジェクトのルート ディレクトリで、次のコマンドを使用してサーバーを実行します:

$ node server.js

すべてがうまくいけば、コマンドが成功したことが表示されます。行 データベースへの接続とサーバーが開始されたメッセージ。これで、ブラウザまたは Postman で API のさまざまなルート (http://localhost:3000/api/products など) にアクセスできるようになりました。

概要
MongoDB と Node.js を使用すると、シンプルな CRUD API を簡単に開発できます。この記事では、MongoDB データベース、Node.js、Express.js フレームワークを使用して単純な CRUD API を作成する方法を学び、具体的なコード例を示しました。 MongoDB と Node.js をより深く理解すると、実際のニーズに応じて API を拡張およびカスタマイズできます。

以上がMongoDB を使用して単純な CRUD API を開発する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。