在 Node.js 的 web 开发中，Express 是一个常用的 Node.js web 框架。它提供了一些有用的功能，比如路由系统、请求与响应等。但是，如果每次都从零开始写一个 Express 应用的话，无疑是十分耗时的。为此，开发者们开发了一些 Express 应用生成器，其中包括我们今天要介绍的 express-rest-api-generator。它可以自动生成基于 Express 的 REST API 应用程序。
安装
在使用 express-rest-api-generator 之前，需要确保 Node.js 已经安装。安装 Node.js 的方法在此不再赘述。安装好 Node.js 后，你可以使用全局的 npm 工具来安装 express-rest-api-generator。
--- ------- -- --------------------------
使用
安装好之后，你可以使用以下命令来生成 REST API 应用程序。
-------------------------- --------------
在 [project-name] 处填写你想要创建的应用程序的名称。express-rest-api-generator 将自动创建一个以该名称为基础的目录，并在其中生成你的应用程序的代码。默认情况下，该基础目录是当前工作目录，也可以提供路径。
-------------------------- -----------------
express-rest-api-generator 默认会使用 SQLite 数据库作为其底层数据库。如果需要使用其他数据库，可以通过在命令行中设置环境变量来指定。例如，如果想要使用 MySQL，可以使用以下命令：
-------------- -------------------------- --------------
结构
生成的应用程序的目录结构如下：
- ------------
- ---
- ---
- ------------
- ------
- ------
- --------
- -----
- ------
- ------------其中，
- bin 目录包含了用于启动服务的脚本文件。
- node_modules 目录包含了所有依赖包。
- public 目录包含了前端资源文件（如 CSS、JavaScript、图像等）。
- routes 目录包含了定义 API 路径的代码文件。
- views 目录包含了后端模板文件。在 REST API 应用中，该目录为空。
- app.js 是整个应用程序的入口文件。
- package.json 是应用程序的配置文件。
在 routes 目录中，index.js 文件是默认的 API 文件。它包含了一些示例代码，可以作为一个初步的 API 实现。
编写 API
由于 REST API 是基于 HTTP 协议的，所以编写 API 代码时需要考虑 HTTP 的规范。API 的实现通常以编写处理 HTTP 请求的路由处理函数为开始。
定义路由
在 routes 目录中的 index.js 文件中，可以定义路由，例如：
--- ------- - ------------------- --- ------ - ----------------- --------------- ------------- ---- ----- - ---------- -------- ------ ------- --- --- -------------- - -------
该代码定义了一个 GET 请求路由。在浏览器访问该路由时，将返回一个 JSON 对象 { message: 'Hello World!' }。
传递参数
在 REST API 中，URI 可以通过参数方式传递。比如，我们可以在路由中定义一个包含参数的路由实现。例如：
------------------ ------------- ---- ----- - ---------- --- ------------- --- ---
当客户端访问 /123 时，将返回一个 JSON 对象 { id: '123' }。这里，:id 代表一个参数，参数的值可以通过 req.params.id 获取。
处理请求体
在 REST API 中，请求体通常包含了客户端的数据。处理这些数据时，你需要使用中间件来将数据从请求体中提取出来。express-rest-api-generator 默认使用 body-parser 来解析请求体。因此，你不需要自己编写处理请求体的代码了。只需要直接使用 req.body 就可以访问到请求体中的数据了。
处理响应
在实现 API 时，需要对数据进行处理，并将处理后的数据返回给客户端。在 express-rest-api-generator 中，你可以使用 res.json() 方法来处理响应数据。该方法接受一个 JSON 对象作为参数，将自动设置响应头文件，并将数据转换为 JSON 格式返回。例如：
--------------- ------------- ---- ----- - --- ---- - - -------- ------ ------- -- --------------- ---
启动服务
在完成 API 代码的编写后，可以启动应用程序并访问 API。使用以下命令来启动服务。
--- -----
该命令将运行 bin/www 中的脚本，并启动服务。默认情况下，服务将监听在 3000 端口上。你可以在浏览器中访问 http://localhost:3000 来查看是否运行正常。
总结
在本文中，我们介绍了如何使用 express-rest-api-generator 来生成 REST API 应用程序，并对其进行修改以满足需求。使用它可以快速搭建一个 REST API 项目，使得开发工作变得更加高效。我们相信通过阅读本文，您已经掌握了使用 express-rest-api-generator 的技巧。希望您可以使用它创造出更为优秀的 web 应用。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055cb681e8991b448da2ef