如何使用 Express.js 和 PostgreSQL 构建 RESTful API

阅读时长 6 分钟读完

在前端开发中,构建 RESTful API 是一项必不可少的任务。而 Express.js 和 PostgreSQL 是两个常用的开发工具。在本文中,我将介绍使用 Express.js 和 PostgreSQL 构建 RESTful API 的详细步骤,以及其学习和指导意义。

什么是 RESTful API

RESTful API 是一种基于 HTTP 协议的 API 架构风格,它使用 HTTP 请求实现各种资源的 CRUD(增删改查)操作。它的核心思想是将每个资源都视为一个 URL,并用 HTTP 方法对其进行操作,比如 GET、PUT、POST、DELETE 等。

RESTful API 的设计应该遵循以下几个原则:

  • 使用标准的 HTTP 方法和状态码。
  • 对请求和响应使用 JSON 格式。
  • 尽可能减少 API 端点的数量。
  • 确定好数据的表现形式,比如时间和货币的格式。
  • 保持 API 的版本兼容性。

使用 Express.js 和 PostgreSQL 构建 RESTful API

步骤一:安装 Express.js 和 PostgreSQL

首先,我们需要安装 Express.js 和 PostgreSQL。使用 npm 命令行工具进行安装:

步骤二:创建数据库

我们需要创建一个数据库,用于存放我们要操作的数据。使用 PostgreSQL 的命令行工具创建数据库:

步骤三:创建 Express.js 应用程序

创建一个名为 index.js 的文件,使用以下代码初始化 Express.js 应用程序:

-- -------------------- ---- -------
----- ------- - ------------------
----- --- - ---------

-----------------------
---------------------------- --------- ---- ---

---------------- -- -- -
    ------------------- --------- -- ---- ------
--

这段代码做了以下几件事情:

  • 引入 express 模块。
  • 创建一个 express 应用程序对象。
  • 配置中间件,使应用程序可以解析 JSON 和 urlencoded 格式的请求体。
  • 启动应用程序并监听 3000 端口。

步骤四:连接到 PostgreSQL 数据库

我们需要使用 pg 模块连接到 PostgreSQL 数据库。将以下代码添加到 index.js 文件中:

-- -------------------- ---- -------
----- - ---- - - -------------

----- ---- - --- ------
    ----- -------
    ----- ------------
    --------- -------
    --------- -----------
    ----- -----
--

------------ ----- ---- -- -
    ------------------ ------- ----- ------- -- -
        -- ----- -
            -------------
        - ---- -
            ---------------------
        -
    --
--

这段代码做了以下几件事情:

  • 引入 pg 模块。
  • 使用 Pool 类连接到 PostgreSQL 数据库。
  • 编写一个路由处理函数,用于查询当前时间并返回结果。

步骤五:编写 RESTful API

现在我们可以编写 RESTful API 了。以下是一个例子:

-- -------------------- ---- -------
----------------- ----- ---- -- -
    ------------------ - ---- ------- ----- ------- -- -
        -- ----- -
            -------------
        - ---- -
            ---------------------
        -
    --
--

------------------ ----- ---- -- -
    ----- - ----- ----- - - --------

    -----------
        ------- ---- ----- ------ ------ ------ ---- -----
        ------ -------
        ----- ------- -- -
            -- ----- -
                -------------
            - ---- -
                -------------- -------
            -
        -
    -
--

--------------------- ----- ---- -- -
    ----- -- - -------------
    ----- - ----- ----- - - --------

    -----------
        ------- ----- --- -------- -------- ----- -------
        ------ ------ ----
        ----- ------- -- -
            -- ----- -
                -------------
            - ---- -
                -------------- ---------
            -
        -
    -
--

------------------------ ----- ---- -- -
    ----- -- - -------------

    ------------------ ---- ----- ----- ------- ----- ----- ------- -- -
        -- ----- -
            -------------
        - ---- -
            -------------- ---------
        -
    --
--

这段代码为 /users 路径添加 CRUD 操作路由,分别是 GET、POST、PUT 和 DELETE。

步骤六:测试 RESTful API

运行应用程序:

启动成功后,可以使用 Postman 工具测试 RESTful API。

总结

本文介绍了如何使用 Express.js 和 PostgreSQL 构建 RESTful API,包括安装 Express.js 和 PostgreSQL、创建数据库、创建 Express.js 应用程序、连接到 PostgreSQL 数据库、编写 RESTful API 和测试。

构建 RESTful API 是前端开发的重要任务之一,熟练掌握 Express.js 和 PostgreSQL 可帮助我们更好地完成这项任务。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/646c80d3968c7c53b0b77554

纠错
反馈