使用Node.js和Express編寫您的第一個API：連接資料庫

使用 Node.js 和 Express 建立 REST API：連接資料庫

在第一個教學「了解 RESTful API」中，我們了解了 REST 架構是什麼、HTTP 請求方法和回應是什麼，以及如何了解 RESTful API 端點。在第二個教學「如何設定Express API 伺服器」中，我們學習如何使用Node 的內建http 模組和Express 框架建立伺服器，以及如何將我們建立的應用程式路由到不同的URL 端點。

目前，當 API 端點被 GET 請求命中時，我們使用靜態資料以 JSON 來源的形式顯示使用者資訊。在本教程中，我們將設定一個MySQL 資料庫來儲存所有數據，從Node.js 應用程式連接到資料庫，並允許API 使用GET、POST、PUT ，和DELETE 方法建立完整的API。

安裝

到目前為止，我們還沒有使用資料庫來儲存或操作任何數據，因此我們將設定一個。本教學將使用 MySQL，如果您的電腦上已安裝 MySQL，則可以繼續下一步。

如果您沒有安裝 MySQL，您可以下載適用於 macOS 和 Windows 的 MAMP，它提供免費的本機伺服器環境和資料庫。下載完成後，打開程式並點擊啟動伺服器啟動 MySQL。

除了設定 MySQL 本身之外，我們還需要 GUI 軟體來檢視資料庫和表格。對於 Mac，請下載 SequelPro，對於 Windows，請下載 SQLyog。下載並執行MySQL 後，您可以使用SequelPro 或SQLyog 在連接埠3306 上使用使用者名稱root 和密碼root 連線到localhost 。

在此處設定完所有內容後，我們就可以繼續為 API 設定資料庫。

設定資料庫

在資料庫檢視軟體中，新增一個新資料庫並將其命名為 api。確保 MySQL 正在運行，否則您將無法連線到 localhost。

建立 api 資料庫後，移入該資料庫並執行下列查詢來建立新表。

CREATE TABLE `users` (
  `id`       int(11)     unsigned NOT NULL AUTO_INCREMENT,
  `name`     varchar(30) DEFAULT '',
  `email`    varchar(50) DEFAULT '',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

此 SQL 查詢將建立 users 表的結構。每個使用者都會有一個自動遞增的 ID、姓名和電子郵件地址。

我們也可以透過執行 INSERT 查詢，使用目前透過靜態 JSON 陣列顯示的相同資料填入資料庫。

INSERT INTO users (name, email) 
     VALUES ('Richard Hendricks', 'richard@piedpiper.com'), 
            ('Bertram Gilfoyle',  'gilfoyle@piedpiper.com');

id欄位不需要輸入，因為它是自動遞增的。此時，我們已經有了表格的結構以及一些可以使用的範例資料。

連接到 MySQL

回到我們的應用程序，我們必須從 Node.js 連接到 MySQL 才能開始處理資料。之前，我們安裝了 mysql npm 模組，現在我們要使用它。

建立一個名為data的新目錄並建立一個config.js檔案。

我們首先需要 data/config.js 中的 mysql 模組。

const mysql = require('mysql');

讓我們建立一個 config 對象，其中包含主機、使用者、密碼和資料庫。這應該引用我們製作的api資料庫並使用預設的localhost設定。

// Set database connection credentials
const config = {
    host: 'localhost',
    user: 'root',
    password: 'root',
    database: 'api',
};

為了提高效率，我們將建立一個 MySQL 池，它允許我們一次使用多個連接，而不必手動開啟和關閉多個連接。

// Create a MySQL pool
const pool = mysql.createPool(config);

最後，我們將匯出 MySQL 池，以便應用程式可以使用它。

// Export the pool
module.exports = pool;

您可以在我們的 GitHub 儲存庫中查看完整的資料庫設定檔。

現在我們正在連接到 MySQL 並且設定已完成，我們可以繼續透過 API 與資料庫進行互動。

從 MySQL 取得 API 資料

目前，我們的 routes.js 檔案正在手動建立使用者的 JSON 數組，如下所示。

const users = [{ ...

由於我們不再使用靜態數據，因此我們可以刪除整個數組並將其替換為指向 MySQL 池的連結。

// Load the MySQL pool connection
const pool = require('../data/config');

以前，/users 路徑的 GET 發送靜態 users 資料。我們更新後的程式碼將改為在資料庫中查詢該資料。我們將使用 SQL 查詢 SELECT 來自 users 表，如下所示。

SELECT * FROM users

這是我們新的 /users 取得路由的樣子，使用 pool.query() 方法。

// Display all users
app.get('/users', (request, response) => {
    pool.query('SELECT * FROM users', (error, result) => {
        if (error) throw error;

        response.send(result);
    });
});

在這裡，我們執行 SELECT 查詢，然後透過 /users 端點將結果以 JSON 形式傳送到客戶端。如果您重新啟動伺服器並導航到 /users 頁面，您將看到與以前相同的數據，但現在它是動態的。

使用 URL 参数

到目前为止，我们的端点都是静态路径 - / root 或 /users - 但是当我们只想查看有关特定用户的数据时该怎么办？我们需要使用可变端点。

对于我们的用户，我们可能希望根据每个用户的唯一 ID 检索有关每个用户的信息。为此，我们将使用冒号 (:) 来表示它是一个路由参数。

// Display a single user by ID
app.get('/users/:id', (request, response) => {
        ...
    });
});

我们可以使用 request.params 属性检索此路径的参数。由于我们的名称为 id，因此我们将这样引用它。

const id = request.params.id;

现在，我们将在 SELECT 语句中添加 WHERE 子句，以仅获取具有指定 id 的结果。

我们将使用 ? 作为占位符以避免 SQL 注入，并将 id 作为参数传递，而不是构建一个连接字符串，这会降低安全性。

pool.query('SELECT * FROM users WHERE id = ?', id, (error, result) => {
    if (error) throw error;

    response.send(result);
});

我们个人用户资源的完整代码现在如下所示：

// Display a single user by ID
app.get('/users/:id', (request, response) => {
    const id = request.params.id;

    pool.query('SELECT * FROM users WHERE id = ?', id, (error, result) => {
        if (error) throw error;

        response.send(result);
    });
});

现在您可以重新启动服务器并导航到 https://localhost/users/2 以仅查看 Gilfoyle 的信息。如果出现 Cannot GET /users/2 之类的错误，则说明您需要重新启动服务器。

访问此 URL 应返回一个结果。

[{
    id: 2,
    name: "Bertram Gilfoyle",
    email: "gilfoyle@piedpiper.com"
}]

如果您看到的是这样的内容，那么恭喜您：您已成功设置动态路由参数！

发送 POST 请求

到目前为止，我们所做的一切都使用了 GET 请求。这些请求是安全的，这意味着它们不会改变服务器的状态。我们只是查看 JSON 数据。

现在我们将开始通过使用 POST 请求添加新数据来使 API 真正动态化。

我之前在理解 REST 文章中提到，我们不会在 URL 中使用 add 或 delete 等动词来执行操作。为了向数据库添加新用户，我们将 POST 到我们查看它们的同一 URL，但只需为其设置一个单独的路由。

// Add a new user
app.post('/users', (request, response) => {
    ...
});

请注意，我们现在使用 app.post() 而不是 app.get()。

由于我们是创建而不是读取，因此我们将在此处使用 INSERT 查询，就像我们在数据库初始化时所做的那样。我们将整个 request.body 发送到 SQL 查询。

pool.query('INSERT INTO users SET ?', request.body, (error, result) => {
    if (error) throw error;

我们还将指定响应的状态为 201，它代表 Created。为了获取最后插入的项目的 id，我们将使用 insertId 属性。

response.status(201).send(`User added with ID: ${result.insertId}`);

我们的整个 POST 接收代码将如下所示。

// Add a new user
app.post('/users', (request, response) => {
    pool.query('INSERT INTO users SET ?', request.body, (error, result) => {
        if (error) throw error;

        response.status(201).send(`User added with ID: ${result.insertId}`);
    });
});

现在我们可以通过发送一个 POST 请求了。大多数情况下，当您发送 POST 请求时，您是通过 Web 表单执行的。我们将在本文末尾学习如何进行设置，但发送测试 POST 的最快、最简单的方法是使用 cURL，使用 -d (--data) 标志。

我们将运行 curl -d，后跟包含所有键/值对和请求端点的查询字符串。

curl -d "name=Dinesh Chugtai&email=dinesh@piedpiper.com" http://localhost:3002/users

发送此请求后，您应该会从服务器收到响应。

User added with ID: 3

如果您导航到 http://localhost/users，您将看到添加到列表中的最新条目。

发送 PUT 请求

POST 对于添加新用户很有用，但我们希望使用 PUT 来修改现有用户。 PUT 是幂等的，这意味着您可以多次发送相同的请求，并且只会执行一个操作。这与 POST 不同，因为如果我们多次发送新用户请求，它会不断创建新用户。

对于我们的 API，我们将设置 PUT 以便能够处理编辑单个用户，因此这次我们将使用 :id 路由参数。

让我们创建一个 UPDATE 查询，并确保它仅适用于带有 WHERE 子句的请求 ID。我们使用两个 ? 占位符，我们传递的值将按顺序排列。

// Update an existing user
app.put('/users/:id', (request, response) => {
    const id = request.params.id;

    pool.query('UPDATE users SET ? WHERE id = ?', [request.body, id], (error, result) => {
        if (error) throw error;

        response.send('User updated successfully.');
    });
});

在我们的测试中，我们将编辑用户 2 并将电子邮件地址从 gilfoyle@piedpiper.com 更新为 bertram@piedpiper.com。我们可以再次使用 cURL，并使用 [-X (--request)] 标志来明确指定我们要通过其发送 PUT 请求。

curl -X PUT -d "name=Bertram Gilfoyle" -d "email=bertram@piedpiper.com" http://localhost:3002/users/2

请确保在发送请求之前重新启动服务器，否则您将收到 Cannot PUT /users/2 错误。

你应该看到这个：

User updated successfully.

现在应该更新 ID 为 2 的用户数据。

发送删除请求

我们完成 API 的 CRUD 功能的最后一个任务是选择从数据库中删除用户。此请求将使用 DELETE SQL 查询和 WHERE，并且它将删除由路由参数指定的单个用户。

// Delete a user
app.delete('/users/:id', (request, response) => {
    const id = request.params.id;

    pool.query('DELETE FROM users WHERE id = ?', id, (error, result) => {
        if (error) throw error;

        response.send('User deleted.');
    });
});

我们可以再次使用 -X 和 cURL 来发送删除。让我们删除我们创建的最新用户。

curl -X DELETE http://localhost:3002/users/3

您将看到成功消息。

User deleted.

导航到 http://localhost:3002，您会看到现在只有两个用户。

恭喜！至此，API就完成了。访问 GitHub 存储库以查看 routes.js 的完整代码。

通过request模块发送请求

在本文的开头，我们安装了四个依赖项，其中之一是 request 模块。您可以创建一个包含所有数据的新文件并将其发送，而不是使用 cURL 请求。我将创建一个名为 post.js 的文件，该文件将通过 POST 创建一个新用户。

const request = require('request');

const json = {
    "name": "Dinesh Chugtai",
    "email": "dinesh@piedpiper.com",
};

request.post({
    url: 'http://localhost:3002/users',
    body: json,
    json: true,
}, function (error, response, body) {
    console.log(body);
});

我们可以在服务器运行时在新的终端窗口中使用 node post.js 来调用它，它与使用 cURL 具有相同的效果。如果 cURL 出现问题，request 模块很有用，因为我们可以查看错误、响应和正文。

通过 Web 表单发送请求

通常，POST 和其他改变服务器状态的 HTTP 方法是使用 HTML 表单发送的。在这个非常简单的示例中，我们可以在任何地方创建一个 index.html 文件，并为姓名和电子邮件地址创建一个字段。表单的操作将指向资源，在本例中为 http//localhost:3002/users，我们将方法指定为 post。

创建index.html并向其中添加以下代码：

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <title>Node.js Express REST API</title>
</head>

<body>
    <form action="http://localhost:3002/users" method="post">
        <label for="name">Name</label>
        <input type="text" name="name">
        <label for="email">Email</label>
        <input type="email" name="email">
        <input type="submit">
    </form>
</body>

</html>

在浏览器中打开此静态 HTML 文件，填写该文件，然后在服务器在终端中运行时发送它。您应该会看到 添加了 ID 为 4 的用户的响应，并且您应该能够查看新的用户列表。

结论

在本教程中，我们学习了如何将 Express 服务器连接到 MySQL 数据库，并设置与路径和动态路由的 GET、POST、PUT 和 DELETE 方法相对应的路由参数。我们还学习了如何使用 cURL、Node.js request 模块和 HTML 表单向 API 服务器发送 HTTP 请求。

此时，您应该非常了解 RESTful API 的工作原理，并且您现在可以使用 Express 和 MySQL 在 Node.js 中创建自己的成熟 API！

以上是使用Node.js和Express編寫您的第一個API：連接資料庫的詳細內容。更多資訊請關注PHP中文網其他相關文章！