您是否打算使用nodejs创建REST API?在这篇博客文章中,我们将演示如何使用Fastify(nodejs的良好且紧凑的Web框架)创建直接的REST API。 Fastify是创建API的绝佳选择,因为它是为了速度和有效性而构建的。
在本教程中,我们将介绍以下主题:
1。设置项目
2。构建API
3。添加更多路线
4。测试API
5。结论
所以,让我们潜入!
1.设置项目
制作一个新的项目目录并用NPM初始化它是第一步。打开终端后运行以下命令:
mkdir fastify-api
cd fastify-api
npm init -y
这将创建一个称为 fastify-api 的新目录,并用 package.json 文件初始化它。
安装快速及其依赖项接下来是。要安装快速,请执行以下命令:
npm install fastify
2.构建API
设置项目并安装快速化后,我们现在可以开始创建我们的API。让我们首先在项目目录的root中创建一个名为index.js的新文件。
const fastify = require('fastify')();
fastify.get('/', async (request, reply) => {
return { message: 'Hello, World!' };
});
fastify.listen(3000, (err, address) => {
if (err) {
console.error(err);
process.exit(1);
}
console.log(`Server listening on ${address}`);
});
在这种情况下,进口了Fastify,并制定了新实例。然后,我们创建了一条响应的路线,以获取我们API根的请求。一个包含消息“ Hello,World!”的JSON对象。由路由处理程序返回。
最后,我们使用 listing()方法在端口3000上启动服务器。我们将错误记录到控制台,并在此过程中停止该过程。在没有这样的情况下,我们记录了服务器的侦听IP。
3.添加更多路线
现在,我们的基本API正在运行,让我们添加更多路线。作为说明,让我们实施一条路由,该路由对发布请求响应/api/strong>端点,然后返回包含用户名称和电子邮件的JSON对象。
fastify.post('/api/users', async (request, reply) => {
const { name, email } = request.body;
return { name, email };
});
在这种情况下,构建了一条新路由,以处理/api/users的邮政请求 url。 名称和电子邮件属性是由路由处理程序从请求主体中提取的,然后使用破坏性构建,然后返回带有这些属性的JSON对象。
4.测试API
我们可以使用工具 Postman 或 curl 测试我们的API。在这里,我们将以 curl 为例。
通过运行命令来启动服务器:
node index.js
然后,打开一个新的终端窗口并运行以下命令以将get请求发送至我们的API的根:
curl http://localhost:3000/
这应该返回带有消息“ Hello,World!”的JSON对象。
接下来,让我们向我们的 /API /用户端点发送邮政请求。运行以下命令:
curl -X POST -H "Content-Type: application/json" -d '{"name":"John Doe","email":"john
5.结论
在本文中,我们演示了如何使用fastify和nodejs创建直接的REST API。我们介绍了启动项目,创建路线并使用卷曲测试API的基本原理。
当然,这仅仅是开始。快速化可用于创建具有额外功能(例如数据库集成和身份验证)的更复杂的API。
我们希望本指南可以帮助您开始使用Fastify和nodejs创建自己的REST API。编码很有趣!