MagicAPIService (magic-api 1.7.2 API)

所有超级接口:

MagicModule

所有已知实现类:

DefaultMagicAPIService
```
public interface MagicAPIService
extends MagicModule
```
API调用接口

作者:

mxd

方法概要

All Methods Instance Methods Abstract Methods
限定符和类型	方法和说明
`List<ApiInfo>`	`apiList()` 获取接口列表
`<T> T`	`call(String method, String path, Map<String,Object> context)` 执行MagicAPI中的接口,带code和message信息
`String`	`copyGroup(String src, String target)` 复制分组
`String`	`createGroup(Group group)` 创建分组
`List<DataSourceInfo>`	`datasourceList()` 数据源列表
`boolean`	`deleteApi(String id)` 删除接口
`boolean`	`deleteDataSource(String id)` 删除数据源
`boolean`	`deleteFunction(String id)` 删除函数
`boolean`	`deleteGroup(String id)` 删除分组
`void`	`download(String groupId, List<SelectedResource> resources, OutputStream os)` 下载
`<T> T`	`execute(String method, String path, Map<String,Object> context)` 执行MagicAPI中的接口,原始内容，不包含code以及message信息
`List<FunctionInfo>`	`functionList()` 获取函数列表
`ApiInfo`	`getApiInfo(String id)` 获取接口详情
`DataSourceInfo`	`getDataSource(String id)` 获取数据源详情
`FunctionInfo`	`getFunctionInfo(String id)` 获取函数详情
`Group`	`getGroup(String id)` 查询分组详情
`List<Group>`	`groupList(String type)` 查询分组列表
`<T> T`	`invoke(String path, Map<String,Object> context)` 执行MagicAPI中的函数
`boolean`	`lockApi(String id)` 锁定接口
`boolean`	`lockFunction(String id)` 锁定函数
`boolean`	`moveApi(String id, String groupId)` 移动接口
`boolean`	`moveFunction(String id, String groupId)` 移动函数
`boolean`	`processNotify(MagicNotify magicNotify)` 处理刷新通知
`JsonBean<?>`	`push(String target, String secretKey, String mode, List<SelectedResource> resources)` 远程推送
`void`	`registerAllDataSource()` 注册数据源
`String`	`saveApi(ApiInfo apiInfo)` 保存接口
`String`	`saveDataSource(DataSourceInfo properties)` 保存数据源
`String`	`saveFunction(FunctionInfo functionInfo)` 保存函数
`String`	`testDataSource(DataSourceInfo properties)` 测试数据源
`boolean`	`unlockApi(String id)` 解锁接口
`boolean`	`unlockFunction(String id)` 解锁函数
`boolean`	`updateGroup(Group group)` 修改分组信息
`void`	`upload(InputStream inputStream, String mode)` 上传

从接口继承的方法 org.ssssssss.magicapi.config.MagicModule
getModuleName

- 方法详细资料
  - execute
```
<T> T execute(String method,
              String path,
              Map<String,Object> context)
```
    执行MagicAPI中的接口,原始内容，不包含code以及message信息
    
    参数:
    
    method - 请求方法
    
    path - 请求路径
    
    context - 变量信息
    
    返回:
    
    返回执行结果
  - call
```
<T> T call(String method,
           String path,
           Map<String,Object> context)
```
    执行MagicAPI中的接口,带code和message信息
    
    参数:
    
    method - 请求方法
    
    path - 请求路径
    
    context - 变量信息
    
    返回:
    
    返回执行结果，包装JsonBena处理
  - invoke
```
<T> T invoke(String path,
             Map<String,Object> context)
```
    执行MagicAPI中的函数
    
    参数:
    
    path - 函数路径
    
    context - 变量信息
    
    返回:
    
    返回函数执行结果
  - saveApi
```
String saveApi(ApiInfo apiInfo)
```
    保存接口
    
    参数:
    
    apiInfo - 接口信息
    
    返回:
    
    保存成功后，返回Id
  - lockApi
```
boolean lockApi(String id)
```
    锁定接口
    
    参数:
    
    id - 接口ID
    
    返回:
    
    是否锁定成功
  - unlockApi
```
boolean unlockApi(String id)
```
    解锁接口
    
    参数:
    
    id - 接口ID
    
    返回:
    
    是否解锁成功
  - lockFunction
```
boolean lockFunction(String id)
```
    锁定函数
    
    参数:
    
    id - 函数ID
    
    返回:
    
    是否锁定成功
  - unlockFunction
```
boolean unlockFunction(String id)
```
    解锁函数
    
    参数:
    
    id - 接口ID
    
    返回:
    
    是否解锁成功
  - getApiInfo
```
ApiInfo getApiInfo(String id)
```
    获取接口详情
    
    参数:
    
    id - 接口id
    
    返回:
    
    返回接口信息
  - apiList
```
List<ApiInfo> apiList()
```
    获取接口列表
    
    返回:
    
    返回接口信息列表
  - deleteApi
```
boolean deleteApi(String id)
```
    删除接口
    
    参数:
    
    id - 接口id
    
    返回:
    
    是否删除成功
  - moveApi
```
boolean moveApi(String id,
                String groupId)
```
    移动接口
    
    参数:
    
    id - 接口id
    
    groupId - 分组id
    
    返回:
    
    是否移动成功
  - saveFunction
```
String saveFunction(FunctionInfo functionInfo)
```
    保存函数
    
    参数:
    
    functionInfo - 函数信息
    
    返回:
    
    保存成功后，返回Id
  - getFunctionInfo
```
FunctionInfo getFunctionInfo(String id)
```
    获取函数详情
    
    参数:
    
    id - 函数id
    
    返回:
    
    返回函数信息
  - functionList
```
List<FunctionInfo> functionList()
```
    获取函数列表
    
    返回:
    
    返回函数信息列表
  - deleteFunction
```
boolean deleteFunction(String id)
```
    删除函数
    
    参数:
    
    id - 函数id
    
    返回:
    
    是否删除成功
  - moveFunction
```
boolean moveFunction(String id,
                     String groupId)
```
    移动函数
    
    参数:
    
    id - 函数id
    
    groupId - 分组id
    
    返回:
    
    是否移动成功
  - createGroup
```
String createGroup(Group group)
```
    创建分组
    
    参数:
    
    group - 分组信息
    
    返回:
    
    创建成功后返回分组id
  - updateGroup
```
boolean updateGroup(Group group)
```
    修改分组信息
    
    参数:
    
    group - 分组信息
    
    返回:
    
    是否修改成功
  - deleteGroup
```
boolean deleteGroup(String id)
```
    删除分组
    
    参数:
    
    id - 分组id
    
    返回:
    
    是否删除成功
  - groupList
```
List<Group> groupList(String type)
```
    查询分组列表
    
    参数:
    
    type - 分组类型，1 接口分组，2 函数分组
    
    返回:
    
    返回分组信息列表
  - getGroup
```
Group getGroup(String id)
```
    查询分组详情
    
    参数:
    
    id - 分组ID
    
    返回:
    
    返回分组对象
  - registerAllDataSource
```
void registerAllDataSource()
```
    注册数据源
  - getDataSource
```
DataSourceInfo getDataSource(String id)
```
    获取数据源详情
    
    参数:
    
    id - 数据源id
    
    返回:
    
    返回数据源信息
  - datasourceList
```
List<DataSourceInfo> datasourceList()
```
    数据源列表
    
    返回:
    
    返回数据源信息列表
  - testDataSource
```
String testDataSource(DataSourceInfo properties)
```
    测试数据源
    
    参数:
    
    properties - 数据源属性
    
    返回:
    
    返回错误说明，连接正常返回 null
  - saveDataSource
```
String saveDataSource(DataSourceInfo properties)
```
    保存数据源
    
    参数:
    
    properties - 数据源属性
    
    返回:
    
    返回数据源ID
  - deleteDataSource
```
boolean deleteDataSource(String id)
```
    删除数据源
    
    参数:
    
    id - 数据源id
    
    返回:
    
    是否删除成功
  - upload
```
void upload(InputStream inputStream,
            String mode)
     throws IOException
```
    上传
    
    参数:
    
    inputStream - 输入流
    
    mode - 模式，全量和增量
    
    抛出:
    
    IOException - 读取失败抛出的异常
  - download
```
void download(String groupId,
              List<SelectedResource> resources,
              OutputStream os)
       throws IOException
```
    下载
    
    参数:
    
    groupId - 分组ID
    
    resources - 选择的资源对象
    
    os - 输出流
    
    抛出:
    
    IOException - 下载失败时抛出的异常
  - push
```
JsonBean<?> push(String target,
                 String secretKey,
                 String mode,
                 List<SelectedResource> resources)
```
    远程推送
    
    参数:
    
    target - 推送目标
    
    secretKey - 秘钥
    
    mode - 推送模式
    
    resources - 选择的资源
    
    返回:
    
    推送结果
  - processNotify
```
boolean processNotify(MagicNotify magicNotify)
```
    处理刷新通知
    
    参数:
    
    magicNotify - 通知对象
    
    返回:
    
    是否处理成功
  - copyGroup
```
String copyGroup(String src,
                 String target)
```
    复制分组
    
    参数:
    
    src - 源分组ID
    
    target - 目标分组ID
    
    返回:
    
    新分组的ID

接口 MagicAPIService

方法概要

从接口继承的方法 org.ssssssss.magicapi.config.MagicModule

方法详细资料

execute

call

invoke

saveApi

lockApi

unlockApi

lockFunction

unlockFunction

getApiInfo

apiList

deleteApi

moveApi

saveFunction

getFunctionInfo

functionList

deleteFunction

moveFunction

createGroup

updateGroup

deleteGroup

groupList

getGroup

registerAllDataSource

getDataSource

datasourceList

testDataSource

saveDataSource

deleteDataSource

upload

download

push

processNotify

copyGroup