使用Node.js、MongoDB、Fastify 构建 API 服务
发布网友
发布时间：2024-10-05 08:27
共1个回答
热心网友
时间：2024-10-17 00:33
打开终端，创建项目目录 `restful-api`，进入目录后创建代码文件夹 `src`，在 `src` 目录下创建 `index.js` 文件。
初始化项目，执行 `npm init` 命令，生成 `package.json` 文件。
安装相关依赖项，包括 `nodemon`、`Mongoose`、`Fastify`、`fastify-swagger` 和 `boom`。这些工具将提供自动重启、数据建模、高性能 Web 开发体验、API 文档生成以及错误处理等功能。
在 `index.js` 中引入 `Fastify` 框架并声明第一个路由，设置服务运行端口为 8100，开启内置 logger。
启动服务，运行 `nodemon index.js` 命令。
使用浏览器访问 `http://127.0.0.1:8100/`，查看返回信息。
下一步是设置 MongoDB 数据库。
启动 MongoDB 实例，使用 Mongoose 连接数据库。在 `index.js` 中增加代码以创建并连接数据库，数据库名称为 `crayon-restful-service`。
在 `models` 目录下创建 `Coffee.js` 文件，定义 Coffee 模型。
在 `controllers` 目录下创建 `coffeeController.js` 文件，实现 Coffee 数据的 CRUD 操作。
在 `routes` 目录下创建 `index.js` 文件，定义接口路由并设置控制器方法。
为每个路由设置 `id` 参数，用于传递参数。
创建 API 文档，使用 Swagger 对文档进行支持。在 `config` 目录下创建 `swagger.js` 文件，配置 Swagger 插件。
在 `docs` 目录下创建 `coffees.js` 文件，定义 API 文档。导入并更新每个路由，增加 `schema` 属性。
使用 Postman 测试 API 服务。
关于部署，可以使用 `pm2` 或 `docker` 进行，具体部署方法不在此处展开。
总结，通过上述步骤构建了一个简单的 REST API 服务，可以进一步迭代和扩展，包括增加模型验证、列表分页等功能，以满足实际项目需求。
