API文档
公共请求
POST
/版本号/模块/接口名[query|/params]
这是所有请求的公共参数,所有的接口都遵循这个规律, 所以后面的接口将只列出接口独有的入参和请求成功返回的业务数据(data属性)
CRUD相关接口
以下5个接口是CRUD页面使用的接口,实际后端应该每一个实体后分别有这5个接口,将接口名里面的Modle替换成具体的实体名称,给前端调用。
查询实体列表
POST
/v1/page/searchModel
用于查询动态CURD页面的数据列表的接口,这个接口的入参会包含页面上搜索表单中所有非空的字段和下面列表的参数
Request Body
pageSize
number
每页显示条数,默认10
pageNum
number
当前页码,默认1
查询单个实体
POST
/v1/page/getModel/:id
查询单个实体,用于CRUD页面编辑表单的数据初始化
Path Parameters
id
string
实体的id
保存实体
POST
/v1/page/saveModel
CRUD页面的新增和更新实体的操作
Path Parameters
object
需要新增/更新的实体
删除一条数据
POST
/v1/page/delModel/:id
CRUD页面通过id删除一条数据的接口
Path Parameters
id
string
实体的id
查看详情的
POST
/v1/page/viewModel/:id
CRUD页面查看数据详情的接口
Path Parameters
id
string
实体id
表单相关接口
获取选项
POST
/v1/base/getOptions
获取选择型组件的选项数据
Query Parameters
code
string
数据源的标识,后端根据这个标识返回不同的数据
type
string
数据源类型,后端根据这个类型返回不同的数据结构,如树、表格等
获取选项(dialog)
POST
/v1/base/getPageOptions/:code
获取弹窗选择器的选择项数据
Path Parameters
code
string
CRUD页面的code
Dashboard相关接口
查找所有的Dashboard
POST
/v1/base/getAllDashboard
查找所有可以添加到首页的仪表盘
用户的DashBoard布局
POST
/v1/base/getUserDashboard
查找用户已经添加到首页的仪表盘布局,如果用户没有配置过,则返回所有仪表盘的前8个
保存用户的Dashboard布局
POST
/v1/base/saveUserDashboard
Request Body
userDashboards
array
用户仪表盘配置数组
其他业务接口
用户登录
POST
/v1/public/login
Request Body
name
string
用户名
password
string
密码
获取权限数据
POST
/v1/base/getAuth
获取用户的权限数据
退出登录
POST
/v1/public/logout
查询表单/页面列表
POST
/v1/page/searchPage
查询系统配置好的动态表单和页面的分页数据
Request Body
pageSize
number
每页显示数据条数,默认10
pageNum
number
当前页,默认1
获取表单/页面数据
POST
/v1/page/getPage/:code
通过页面代码获取页面数据
Path Parameters
code
string
页面代码
保存表单/页面数据
POST
/v1/page/savePage
Request Body
object
page对象
删除表单/页面
POST
/v1/page/delPage/:id
根据id删除表单或页面
Path Parameters
id
string
要删除的页面id
获取菜单树
POST
/v1/system/menuTree
以树形结构查询所有的菜单
保存菜单
POST
/v1/system/saveMenu
新增或修改菜单
Request Body
object
菜单对象
删除菜单
POST
/v1/system/delMenu/:id
通过id删除菜单
Path Parameters
id
string
菜单id
Last updated