前言
随着前端开发的迅猛发展,前端越来越需要使用后端的数据,而后端开发人员也需要更便捷地提供数据接口。这时,CRUD 增删改查操作成了必备的技能。npm 包 crudder 就是为解决前后端开发人员 CRUD 操作提供方便的工具。
crudder 是什么
crudder 是一个基于配置文件生成前端增删改查代码的 npm 包。它可以减少开发者的重复工作,提高开发效率。它支持配置多个数据源,可以使用 MySQL、MongoDB、PostgreSQL 等关系和非关系型数据库。
安装
在项目中使用 crudder 很简单,首先可以通过 npm 安装:
npm install crudder --save
配置文件
在使用 crudder 之前,我们需要设置一个配置文件。配置文件使用 .yml 或 .yaml 格式。下面是一个配置 mongodb 数据源的示例:
-- -------------------- ---- ------- - ----- ------- ---- - --- ---- ------- --------- - ------ ------- ----- - ----- ------- ---- - ----- ----------- ---- - ----- ------- ------- - ------- ---------- -- - ---- --------------- ----- - ---- --- ---- ------------- ---------- - ---- ---------------- ------ ----- ------ --------- ---- ------- -- -------- ----- ---- --------- ---- ------- ---- ------------- ----- -------- ----------- ----- --------
引入 crudder
在你的项目入口文件中引入 crudder:
const crudder = require('crudder')
使用 crudder
现在我们可以使用 crudder 了,只需要调用下面的代码即可:
const path = require('path') const config = { // 如上面配置文件所示 } crudder(config, path.join(__dirname, 'routes'))
这里的第二个参数是指生成的路由代码所在的文件夹路径。
代码生成
crudder 将生成以下代码:
数据模型
crudder 将根据配置创建一个数据模型并返回它。此模型包含了所有的属性和方法用于访问数据库。
-- -------------------- ---- ------- ----- -------- - ------------------- ----- ---------- - --- ----------------- ------ - ----- ------- --------- ----- ---------- -- -- -------- - ----- ------- --------- ----- ---------- ---- -- ------------- - ----- ---- -- ----------- - ----- ---- -- -- ----- ---- - ---------------------- ----------- -------------- - ----
REST API 路由
crudder 还将建立路由,包含以下 HTTP 方法:
- GET - /api/posts - 获取所有文章
- GET - /api/posts/:id - 获取指定 ID 的文章
- POST - /api/posts - 创建文章
- PUT - /api/posts/:id - 更新指定 ID 的文章
- DELETE - /api/posts/:id - 删除指定 ID 的文章
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ------ - ---------------- ----- ---- - ------------------------- --------------- ----- ----- ---- -- - ----- ----- - ----- ----------- --------------- -- ------------------ ----- ----- ---- -- - ----- ---- - ----- ---------------------------- -------------- -- ---------------- ----- ----- ---- -- - ----- ---- - --- -------------- ----- --------- - ----- ----------- ------------------- -- ------------------ ----- ----- ---- -- - ----- ---- - ----- ------------------------------------- --------- -------------- -- --------------------- ----- ----- ---- -- - ----- ---- - ----- ------------------------------------- -------------- -- -------------- - ------
总结
crudder 是一个非常有价值的 npm 包,可以帮助你生成 CRUD 增删改查代码,大大提高开发效率。通过使用配置文件生成数据模型和 REST API 路由,开发人员可以避免很多乏味的重复劳动,更专注于业务逻辑的开发。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671a730d0927023822655