安装指南 用户指南 文档下载 |
服务总线 /
API新增API新增支持向导模式和脚本模式两种方式。 API向导模式
新增API
Step1:点击新增按钮,进入新增页面,API模式选择向导模式,然后选择数据资源,接着按照向导进行相关参数配置,配置完成,点击提交按钮即可,如下图所示: ![]() Step2: 提交成功后,页面会提示“提交成功”,这时可以在API列表查看到新增的向导模式的API,如下图所示: ![]() 权限分配
API新增成功后,点击API列表操作中的【权限分配】,弹出权限分配弹框,可以为用户分配该API的权限,也可以为具体某角色分配该API的权限,这里 以基于用户为例进行权限分配,点击勾选左侧可选用户中的【用户1】,再点击【>】,将该用户添加到已选用户中,分配完成,点击右下角的【提交】按钮,权限分配完成,如下图所示: ![]() API详情
API新增成功后,点击API列表操作中的【详情】,可以查看该向导模式API的详细配置信息,如下图所示: ![]() 具体详情包含:基础配置信息、参数配置信息等,如下图所示: ![]() ![]() API编辑
Step1:API新增成功后,点击API列表操作中的【修改】,可以对当前API配置进行修改,可对基础配置进行修改,也可对配置参数进行修改,这里以修改请求参数为例,如下图所示: ![]() Step2:点击【设置请求参数】后,弹出对应的参数设置弹框,可以对当前请求参数设置具体的参数名称、操作符、是否必填以及默认值,设置完成点击【保存】即可,如下图所示: ![]() Step3:设置完成,在操作列中会高亮显示设置后的请求或者返回参数,如下图所示: ![]() Step4:修改完成后,可直接点击编辑页面右下角的【提交】,API修改成功,页面给出提示,如下图所示: ![]() API测试
API新增成功后,点击API列表操作中的【测试】,弹出API测试弹框,点击【测试】可直接查看响应结果,如下图所示: ![]() API删除
点击API列表操作中的【删除】,弹出确认弹框,删除该API,点击【确定】,删除成功,如下图所示: ![]() API脚本模式
新增API
Step1:点击新增按钮,进入新增页面,API模式选择脚本模式,设置具体的查询语句、获取参数、进行宏参替换,也可进行数据预览,数据预览结果无误,可点击【提交】按钮保存该API,如下图所示: ![]() Step2:提交成功后,页面会提示“提交成功”,这时可以在API列表查看到新增的脚本模式的API,如下图所示: ![]() 权限分配
API新增成功后,点击API列表操作中的【权限分配】,弹出权限分配弹框,可以为用户分配该API的权限,也可以为具体某角色分配该API的权限,这里 以基于用户为例进行权限分配,点击勾选左侧可选用户中的【用户1】,再点击【>】,将该用户添加到已选用户中,分配完成,点击右下角的【提交】按钮,权限分配完成,如下图所示: ![]() API详情
API新增成功后,点击API列表操作中的【详情】,可以查看该脚本模式API的详细配置信息,如下图所示: ![]() 具体详情包含:基础配置信息、参数配置信息等,如下图所示: ![]() API编辑
Step1:API新增成功后,点击API列表操作中的【修改】,可以对当前API配置进行修改,可对基础配置进行修改,也可对配置参数中的查询语句进行修改,如下图所示: ![]() Step2:点击【获取参数】,预览请求和返回参数,且可对请求参数设置默认值,设置完成点击【保存】即可,如下图所示: ![]() Step3:点击【宏参替换】,可为SQL中的宏参设置属性值,设置完成点击【保存】即可,如下图所示: ![]() Step4:SQL、参数等设置完成后,可点击【数据预览】,对该API的结果数据进行预览,预览完成点击【保存】即可,如下图所示: ![]() Step5:API修改完成后,可直接点击编辑页面右下角的【提交】,API修改成功,页面给出提示,如下图所示: ![]() API测试
API新增成功后,点击API列表操作中的【测试】,弹出API测试弹框,点击【测试】可直接查看响应结果,如下图所示: ![]() API删除
Step1:点击API列表操作中的【删除】,弹出确认弹框,删除该API,点击【确定】,如下图所示: ![]() Step2:删除成功后,页面会给出删除成功的提示,如下图所示: ![]() API导出
API管理支持将选中的API内容导出到Excel中,如下图所示: ![]() 返回 服务总线 |