介绍
egg-born-module-a-baseadmin
是一个基于 Egg.js 平台开发的后台管理系统基础模块,提供了常用的后台管理功能,包括但不限于用户管理、角色管理、权限管理等等。
该模块以插件的形式存在于 Egg.js 应用中,并提供 RESTful API 和后台管理面板,使得开发者无需重复造轮子,快速搭建自己的后台管理系统。
安装
在你的 Egg.js 应用中执行以下命令安装 egg-born-module-a-baseadmin
:
$ npm install egg-born-module-a-baseadmin
接着,在应用中启动该模块:
// config/plugin.js exports.baseadmin = { enable: true, package: 'egg-born-module-a-baseadmin', };
使用
RESTful API
egg-born-module-a-baseadmin
提供了丰富的 RESTful API,让你可以使用 HTTP 请求的方式访问模块提供的功能。
以下是常用的 API 接口:
/api/a/baseadmin/user/create
创建用户
请求体格式:
{ "userName": "test", "password": "test", "email": "test@example.com" }
/api/a/baseadmin/user/delete
删除用户
请求体格式:
{ "id": 1 }
/api/a/baseadmin/user/update
更新用户
请求体格式:
{ "id": 1, "userName": "test", "password": "test", "email": "test@example.com" }
/api/a/baseadmin/user/get
获取用户
请求体格式:
{ "id": 1 }
/api/a/baseadmin/user/list
获取用户列表
请求体格式:
{ "limit": 10, "offset": 0 }
/api/a/baseadmin/role/create
创建角色
请求体格式:
{ "name": "admin", "displayName": "管理员" }
/api/a/baseadmin/role/delete
删除角色
请求体格式:
{ "id": 1 }
/api/a/baseadmin/role/update
更新角色
请求体格式:
{ "id": 1, "name": "admin", "displayName": "管理员" }
/api/a/baseadmin/role/get
获取角色
请求体格式:
{ "id": 1 }
/api/a/baseadmin/role/list
获取角色列表
请求体格式:
{ "limit": 10, "offset": 0 }
/api/a/baseadmin/permission/create
创建权限
请求体格式:
{ "roleName": "admin", "name": "/api/example", "displayName": "示例 API" }
/api/a/baseadmin/permission/delete
删除权限
请求体格式:
{ "id": 1 }
/api/a/baseadmin/permission/update
更新权限
请求体格式:
{ "id": 1, "roleName": "admin", "name": "/api/example", "displayName": "示例 API" }
/api/a/baseadmin/permission/get
获取权限
请求体格式:
{ "id": 1 }
/api/a/baseadmin/permission/list
获取权限列表
请求体格式:
{ "limit": 10, "offset": 0 }
后台管理面板
egg-born-module-a-baseadmin
还提供了一个基于 Vue.js 开发的后台管理面板,包括用户管理、角色管理、权限管理等功能。
你可以通过访问 /admin/baseadmin
来进入该面板,使用默认的超级管理员账号 root
和密码 root
登录。
示例
以下是一个使用 egg-born-module-a-baseadmin
创建用户的示例代码:
-- -------------------- ---- ------- ----- ----- - ----------------- ----- -------- -------------------- --------- ------ - ----- ------ - ----- --------------------------------------------------------------- - --------- --------- ----- --- ------ ------------ - ------------------ ------- ---------------------------- -- - ----------------- ---
在上面的示例中,我们通过向 /api/a/baseadmin/user/create
接口发送 POST 请求来创建一个新用户,并返回该用户的信息。
总结
egg-born-module-a-baseadmin
是一个非常有用的后台管理系统基础模块,它提供了丰富的 RESTful API 和后台管理面板,让开发者可以快速搭建自己的后台管理系统。通过本文的介绍和示例代码,相信读者已经对该模块的使用方法有了更深入的了解。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedc249b5cbfe1ea0612054