magic-api magic-api
首页
  • 快速入门
  • 基础教程
  • 权限配置
  • 高级应用
  • 开发插件
  • 模块
  • 函数
  • 扩展
  • Gitee (opens new window)
  • Github (opens new window)
  • 演示 (opens new window)
  • SpringBoot配置
  • 编辑器配置
  • 2.x更新日志
  • 1.x更新日志
  • 0.x更新日志
常见问题
💖支持
交流群
首页
  • 快速入门
  • 基础教程
  • 权限配置
  • 高级应用
  • 开发插件
  • 模块
  • 函数
  • 扩展
  • Gitee (opens new window)
  • Github (opens new window)
  • 演示 (opens new window)
  • SpringBoot配置
  • 编辑器配置
  • 2.x更新日志
  • 1.x更新日志
  • 0.x更新日志
常见问题
💖支持
交流群
  • 快速入门

    • 简介
    • 快速开始
    • 请求参数获取
    • 增删改查
    • 单表crud接口
    • 分页
  • 基础教程

    • 界面简介
    • 脚本语法
    • 配置多数据源
    • 统一请求响应
    • 统一异常处理
    • 参数校验
    • 脚本调用Java
    • Java调用接口
      • 调用接口
      • 调用函数
      • 保存资源
      • 删除资源
      • 资源列表
      • 其它API
    • 异步调用
    • 接口发布
    • Lambda
    • Linq
    • 从1.x迁移
  • 权限配置

    • UI鉴权登录
    • UI操作鉴权
    • 接口鉴权
  • 高级应用

    • 自定义拦截器
    • 自定义SQL拦截器
    • 自定义单表API拦截器
    • 自定义SQL缓存
    • 自定义模块
    • 自定义函数
    • 自定义类型扩展
    • 自定义接口存储
    • 自定义数据库方言
    • 自定义列名转换
    • 自定义脚本语言
  • 插件

    • 插件开发
    • 集群插件
    • 定时任务插件
    • Redis插件
    • Mongo插件
    • ElasticSearch插件
    • Swagger插件
    • Git插件
  • 指南
  • 基础教程
mxd
2022-01-29
目录

Java调用接口

# 调用接口

@Autowired
MagicAPIService service;
Map<String, Object> params = new HashMap<>();
// 注入变量信息
params.put("id", 123);
// 内部调用接口不包含code以及message信息,同时也不走拦截器。
Object value = service.execute("GET", "/hello", params);
// 内部调用接口包含code以及message信息,同时也不走拦截器。
// Object value = service.call("GET", "/hello", params);

# 调用函数

@Autowired
MagicAPIService service;

Map<String, Object> params = new HashMap<>();
// 注入变量信息
params.put("a", 1);
params.put("b", 1);
// 调用函数
Object value = service.invoke("/test/add", params);

# 保存资源

@Autowired
MagicResourceService service;
// 保存分组信息
service.saveGroup(group);
// 保存接口(ApiInfo)、函数(FunctionInfo)、数据源(DataSourceInfo)
service.saveFile(apiInfo);

# 删除资源

@Autowired
MagicResourceService service;
// 删除分组或文件
service.delete(id);

# 资源列表

@Autowired
MagicResourceService service;
// 获取分组下的所有文件
service.listFiles(groupId);
// 获取接口(api)、函数(function)、数据源(datasource)列表
service.files(type);
// 获取接口(api)、函数(function)、数据源(datasource)树结构
service.tree(type);
// 获取全部资源的树结构
service.tree();

# 其它API

除了以上列举的API以外 MagicAPIService还有

/**
* 上传
*/
boolean upload(InputStream inputStream, String mode) throws IOException;

/**
* 下载
*/
void download(String groupId, List<SelectedResource> resources, OutputStream os) throws IOException;

/**
* 推送
*/
JsonBean<?> push(String target, String secretKey, String mode, List<SelectedResource> resources);

/**
* 处理刷新通知
*/
boolean processNotify(MagicNotify magicNotify);

MagicResourceService 还有以下方法

/**
* 刷新缓存
*/
void refresh();

/**
* 移动
*
* @param src     源ID
* @param groupId 目标分组
*/

boolean move(String src, String groupId);

/**
* 复制分组
*
* @param src    源ID
* @param target 目标分组
*/
String copyGroup(String src, String target);

/**
* 获取文件详情
*/
<T extends MagicEntity> T file(String id);


/**
* 获取分组详情
*/
Group getGroup(String id);

/**
* 获取完整分组路径
*/
String getGroupPath(String groupId);

/**
* 获取完整分组名称
*/
String getGroupName(String groupId);
上次更新: 2022-08-28 08:18:19
脚本调用Java
异步调用

← 脚本调用Java 异步调用→

Theme by Vdoing | Copyright © 2020-2023 ssssssss.org | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×