什么是 larvitbase-api
Larvitbase-api 是一个基于 Express
框架的 API 服务端框架,其目的是帮助开发者快速建立后端服务,并提供了一些常用的 backend 功能。Larvitbase-api 支持多种数据库,并已经集成了部分 ORM 等插件。
如何使用 larvitbase-api
安装 larvitbase-api
首先,需要使用 npm
安装 larvitbase-api:
npm install larvitbase-api
初始化 larvitbase-api
在初始化 larvitbase-api 前,需要先确定使用的数据库模块。Larvitbase-api 支持 MySQL
和 SQLite3
两种类型的数据库,并集成了相关 ORM 插件。
在代码中引入 larvitbase-api
后,即可初始化一个 app
实例:
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - ---------- ----- ---------- - -------------------------- ----- -------- - - ----- -------- -- -------- --------- - ------- ----- ------------ ----- ----- ----- ------- --------- ----------- --------- -------------- -- ------------------------- -----
其中,dbConfig
对象中为数据库配置信息。如果使用 SQLite3,database
可以省略。
实现一些基本功能
Larvitbase-api 提供了很多实用的、内置的 backend 功能,如带缓存的配置管理和带缓存的 cookie 管理等等。但是,在实际项目中,一些基本功能需要开发者自己实现。
例如,初始化路由、使用中间件等。下面给出一个例子:
-- -------------------- ---- ------- -- ------ -- --- --- --- -------------- ----- ------- - ------------------- ----- --- - ---------- ----- ---------- - -------------------------- ----- -------- - - ----- -------- -- ----- ----- ------------ ----- ----- ----- ------- --------- ----------- --------- -------------- -- ------------------------- ----- -- --------- ------------ -------- ----- ---- ----- - --------------- -------- --- -- ------- ---------------- ----- ---- ----- - -------------------- ------------ ------- --- -- ---- ---------------- -------- -- - ------------------- ---------- ---
Larvitbase-api 中已经集成了很多中间件,例如 cookie-parser
、body-parser
等,开发者可以根据具体需求修改或自己编写中间件。
ORM 使用教程
Larvitbase-api 内置了一个简版 ORM,支持多种类型的数据库,并实现了简单的 CRUD 操作。ORM 使用非常简单,下面以 MySQL 为例:
-- -------------------- ---- ------- -- ---- ----- --- - ------------------------------ ----- ---- - ------------ ------ -------- ------- - --- - -------- ----- -- ------ --- --------- --- -- --- -- ---------- ---- -------------- -- ------------ --- ---- - --- ------- ----------------------- ------- -------- ----- ----- - -- --- --- -- ------------ --- ---- - --- ------- ----------------- - ------------------- -------------------- - --------- -------------------- ----- ----- - -- --- --- -- ------ --- ---- - --- ------- ----------------- - ------------------- ------------------- ---- ---- -------- ----- ----- - -- --- --- -- ------ --- ---- - --- ------- -------------- - -- -------------------- ----- ----- - -- --- ---
在 ORM 中,用户需用 new
关键字新建一个实例。每一个 ORM 实例代表一个表中的实体对象。实体对象包括对应关系映射类、属性和方法。在表中增加、删除、更新和查询操作都是建立在这个实例之上的。
总结
Larvitbase-api 为开发者提供了一套完整的API服务端框架。由于框架实现已经被优化,开发者可以直接调用相关 API 并快速构建自己的后端服务。另外,由于内置 ORM 和很多实用的 backend 功能,因此,Larvitbase-api 在实际开发中还是很方便的。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006735b890c4f7277583f92