Skip to main content

使用系统API

在前面的章节中提到,AIRIOT平台的底层框架使用的是xadmin。与Vue类似,xadmin也提供了一些实用的API,便于前端应用的开发。

xadmin的API

xadmin提供的API接口如下:

App.api(options)

参数:

{Object} options 参数是一个包含组件选项的对象,参数格式如下:

属性说明类型
name请求地址string
resource优先级高于namestring

用法:

调用后端API接口请求或提交数据,相当于fetchaxios。参数是一个包含组件选项的对象,返回一个Promise对象。

import { api } from 'xadmin'

api({ name: `core/t/schema` })
.query({}, {})
.then(json => console.log(json))
.catch(err => console.log(err))

返回值:

[{ name: 'A', id:'A'}, ...]

方法:

query
import { api } from 'xadmin'
// 查询所有表
api({ name: `core/t/schema` })
.query({},{})
.then(json => console.log(json))
.catch(err => console.log(err))

// 查询表记录
const tableId = ''
const filter = { ship: 1, limit: 20, fields: ['device'] }
const wheres = { }
api({ name: `core/t/${tableId}/d` })
.query(filter,wheres)
.then(json => console.log(json))
.catch(err => console.log(err))

filter和wheres参数说明

添加和修改

import { api } from 'xadmin'
const tableId = ''
const data = { id, name, position }
const partial = false
api({ name: `core/t/${tableId}/d` })
.save(data,partial)
.then(json => console.log(json))
.catch(err => console.log(err))
属性说明类型
data保存的数据,存在id时为修改string
partial修改数据时使用PUT或者PATCH方法,默认使用PATCH方法boolean

删除

import { api } from 'xadmin'
const tableId = ''
const id = ''
api({ name: `core/t/${tableId}/d` })
.delete(id)
.then(json => console.log(json))
.catch(err => console.log(err))