简介
RESTful API 是指一种基于网络构建的系统架构风格,当前已经成为了许多 Web 应用开发中最流行的 API 设计风格。本文主要介绍如何使用 Express.js 搭建 RESTful API,使之成为下一代 Node.js Web 应用。
前置知识
本文需要读者具备 JavaScript 基础、Node.js 基础、Express.js 基础等相关知识。
步骤
第一步:创建项目
打开终端,创建一个新项目:mkdir my-express-app && cd my-express-app
。通过 npm init
来初始化项目达到生成 package.json 文件的目的。
第二步:安装和配置 express 和 body-parser
首先安装 Express.js:
npm install express
安装并配置 body-parser,用于解析 POST 请求中的 JSON 数据:
npm install body-parser // 导入 body-parser const bodyParser = require('body-parser') // 使用 body-parser 中间件 app.use(bodyParser.urlencoded({ extend: false })) app.use(bodyParser.json())
第三步:创建路由
在项目根目录下创建一个新目录
/routes
,并在该目录下创建一个文件index.js
。添加以下代码:
-- -------------------- ---- ------- -- -- ------- ----- ------- - ------------------ -- ---- ----- ------ - ---------------- -- ------ --------------- ----- ---- -- - --------------------- -- ----------------------- ----- ---- -- - ----- - ------ ------- - - -------- ------------------ -------- ------------------- -- -- ---- -------------- - ------
第四步:使用路由
- 在项目根目录下的
app.js
中导入路由:
const routes = require('./routes') app.use('/', routes)
- 重新启动服务器,访问
http://localhost:3000/
将能看到 "欢迎访问我的博客!" 字符串。执行 POST 请求将会在控制台上打印出请求中的 title 和 content 字段。
第五步:使用 MongoDB
安装 MongoDB:
npm install mongodb
在项目根目录下新建一个名为
db.js
的文件,并在其中添加以下代码:
-- -------------------- ---- ------- ----- ----------- - ------------------------------ ----- --- - --------------------------- ----- -- - ----------- -- - ----------- - ---- ----------- - --------- - ----- ------- -- - --- - ----- ------ - ----- ------------------------ - ------------------- ---- -- -------------------- ----- ----------- - ------ ------ ------ - ----- --- - ---------------------- - - ----- ------------- ------ - ----- ------ - ----------- --- ---- - ----------- - ----- -------------- ----- -- - ---------------------- ------ ------------------- - ----- ----- -- - -- ------------ --- ----- - ----- ------------------- -------------------- ----- - - - -------------- - --- ----
- 调用 db.js,创建 POST 请求的处理逻辑:
-- -------------------- ---- ------- ----- -- - ---------------- ----------------------- ----- ----- ---- -- - ----- - ------ ------- - - -------- --- - ----- ---------- - ----- ---------------------------- ----- ---------------------- ------ ------- -- ------------------- - ----- --- - ---------------------- ------------------ - --
第六步:应用中间件
安装并引入 helmet,用于增强应用安全性:
npm install helmet
将中间件应用到应用程序中:
const helmet = require('helmet') app.use(helmet())
完整代码
现在我已经使用了以上步骤创建了一个 RESTful API,并使用了 MongoDB 存储文章数据。下面是完整的代码。注意:(1)本文中的代码不针对生产环境,(2)在运行该代码之前,你应该先创建一个名为 my-blog
的数据库。
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ---------- - ---------------------- ----- ------ - ----------------- ----- -- - --------------- ----- --- - --------- ----- ---- - ---- ------------------------------- --------- ----- --- -------------------------- ----------------- ----- ------ - ------------------- ------------ ------- ---------------- -- -- - ------------------- -- --------- -- ---- --------- --
-- -------------------- ---- ------- ----- ------- - ------------------ ----- -- - ---------------- ----- ------ - ---------------- --------------- ----- ---- -- - --------------------- -- ----------------------- ----- ----- ---- -- - ----- - ------ ------- - - -------- --- - ----- ---------- - ----- ---------------------------- ----- ---------------------- ------ ------- -- ------------------- - ----- --- - ---------------------- ------------------ - -- -------------- - ------
-- -------------------- ---- ------- ----- ----------- - ------------------------------ ----- --- - --------------------------- ----- -- - ----------- -- - ----------- - ---- ----------- - --------- - ----- ------- -- - --- - ----- ------ - ----- ------------------------ - ------------------- ---- -- -------------------- ----- ----------- - ------ ------ ------ - ----- --- - ---------------------- - - ----- ------------- ------ - ----- ------ - ----------- --- ---- - ----------- - ----- -------------- ----- -- - ---------------------- ------ ------------------- - ----- ----- -- - -- ------------ --- ----- - ----- ------------------- -------------------- ----- - - - -------------- - --- ----
结论
在本文中,我们学习了如何使用 Express.js 快速搭建 RESTful API 和 MongoDB 的使用。我们还使用了 Helmet 中间件增强了应用程序的安全性。这个文本提供了一个完整的示例代码,与您的 JavaScript 学习和实践相关。通过尝试亲自实践这段代码,您将能够加深对这些工具和技术的理解和应用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6704c826d91dce0dc8503276