录入服务管理基本信息

简介:该模块主要是维护第三方系统提供的restFul协议接口信息,将对应传递的“请求参数”和“返回格式”进行配置化,从而有利其他模块使用,达到同个接口信息只需配置一次即可!

1、创建服务接口信息

首先登录系统,选择【系统管理】-【服务管理】菜单,在左树根目录中,右键单击“添加”按钮,系统自动进入服务接口添加页面,根据所要求的信息输入相关信息,如下图:


温馨提示:3.2.3之前的版本,只需要接口地址信息即可,后续的请求参数配置和返回配置不支持,因此不需要理会,且配置的请求参数和返回仅在【流程定义管理】-【服务节点】使用,【数据模板】暂未支持配置化,还需写脚本进行解析!

1.1、请求参数配置 (此功能3.2.3版本以上支持)

细节说明:在“值/表达式”中,可直接填写固定值,若需要获取表单变量、后端维护脚本方法等,具体说明如下:

1.1.1、缓存变量规则说明 (此功能3.2.3版本以上支持)

  • 说明:缓存数据主要是由前置事件服务解析后写入缓存中的内容

  • 缓存变量规则:{{cache:[服务标识].[属性名]}}

  • 例子:{{cache:dl.data}} ,填写信息细节说明如下:

  • 服务标识中的“dl”信息,来源“登陆”接口中的“标识”信息一致,属性名对应下图红框中信息一致,如下图所示:

  • 在“申请授权码”接口地址时,需要设置“前置事件”,获取登录状态码时,可以使用该缓存规则表达式获取,使用方式如下图:

  • 使用该表达式信息,如下图:

1.1.2、脚本变量规则说明 (此功能3.2.3版本以上支持)

  • 说明:脚本变量主要是获取后端维护的方法返回相关信息或获取表单变量信息进行传参,但需注意暂不支持方法里面传参!

  • 脚本变量规则:{{groovy:[BeanName].[method]}}

  • 例子1:获取当前接收token信息:{{groovy:ContextUtil.getCurrentAccessToken()}}, ,如下图所示:

    在左树对应的接口信息,右键选择“测试(手输参数)”验证接口是否执行成功:

  • 例子2:获取流程定义管理绑定表单,在“服务节点”使用时,获取表单变量信息:{{groovy:jdbd.get(“biaoTi”)}} ,如下图所示:

    注意:
    jdbd.get(“biaoTi”)的信息获取是来源【流程定义管理】-【事件设置】获取表单变量,如下图:

使用Groovy脚本可以调用后端类方法;可以填写在“值/表达式”中使用,也可以在手输参数中使用(参考自定义参数说明)

1.1.3、自定义参数规则说明 (此功能3.2.3版本以上支持)

  • 自定义参数规则:{{params:[属性名]}}

  • 例子:{{params:state}}

  • params是请求时在服务参数中设置

{
  "bodyType": "json",
  "bodyData": {
    "parameters": [],
    "requestPage": {
      "pageNo": 1,
      "limit": "{{params:limit}}" //调用params中的属性名为“limit”的值
    },
    "sorts": []
  },
  "params": {
    "limit": 3 // 在params中定义了属性“limit”,值为“3”
  },
  "headers": {},
  "querys": {}
}

在“组织列表(分页)”执行手输参数,输入上述json字符串进行执行,得到如下结果;当不能使用脚本变量获取动态值时,可以使用自定义参数进行获取。

1.1.4、其他参数说明 (此功能3.2.3版本以上支持)

{
  "bodyType": "json", // 可填写的值为 json/form/raw/file
  "bodyData": { // 指请求体中的数据
    "username": "admin",
    "password": "1"
  },
  "headers": {}, // 请求头数据
  "querys": {}, // URL中的请求参数
  "params": {} // 自定义参数
}

1.2、返回数据设置 (此功能3.2.3版本以上支持)


温馨说明:目前返回格式根据现有系统提供接口返回格式进行默认解析,如果用户有不同格式解析,需要在“响应解析器”开发自有的格式解析器代码!

  • 例子: 根据姓名查询员工基本信息
  • 请求参数配置,如下图:
  • 返回数据设置,如下图:


    参数名:对应接口返回格式信息匹配一致。

2、点击保存按钮

当信息都填写完毕后,点击右上角”保存”按钮,录入服务接口信息完毕,如下图:

文档更新时间: 2020-05-08 14:30   作者:黄春艳