接口引擎使用案例
提供接口引擎增删改查,以及无参或带参查询,并用postman工具调用接口进行测试。
1、postman工具测试
1、确定要开放接口的功能,例如测试服务下“客户管理”功能,对这张表进行增删改查接口操作;
2、维护接口套件下外部用户数据,此用户是在给接口进行授权时用到,例如增强组组件演示用户;
3、在接口引擎中添加相关接口,并分享出接口文档,然后postman能调用并返回结果;
注意:如果切换了数据来源,对应的输出模型需要删除重新导入
3.1 客户管理查询
客户管理查询接口,查询客户管理所有数据,并返回。
3.2 根据条件查询客户管理数据
根据客户名称作为条件查询客户管理数据,并且将子功能数据也返回,要根据条件查询,输入参数需要增加条件,输出参数需要增加子功能的数据集。
3.3 新增客户数据
新增客户数据接口,调用接口给客户功能中添加数据;输入参数要将增加的字段填写上;
3.4 修改客户数据
修改客户数据,根据条件,修改指定数据,输入参数中需要加上条件与需要修改的参数;
3.5 根据条件删除客户数据
根据条件删除数据,输入参数要写上条件参数;
4、以上接口在维护好之后,需要在每一个接口对应的子功能中进行用户授权,这个授权是将第二步维护的外部用户数据导入,并且修改到期时间;
注意:postman在调用时,需要传Headers,里面的信息如下图:
2、SDK使用
为了用户更方便的使用接口引擎,平台提供了api-core.jar包,该jar包封装了参数加密,调用接口服务等功能,下面介绍其使用方式。
1、创建配置文件
如图所示,在resources目录下创建apiInfo.properties的配置文件,配置文件包含5个参数:
参数 | 说明 |
---|---|
host | 接口host地址 |
path | 接口请求路径 |
publicKey | 非对称加密的公钥(参数需要加密时使用) |
userCode | 用户code |
userPassword | 用户密码 |
2、jar包核心方法介绍
如图所示,OperationDataService.execute(String apiCode, String parameter ,boolean encryption),用户只需使用此方法,即可实现调用接口引擎服务,该方法有三个参数:
参数 | 说明 |
---|---|
apiCode | 接口编码 |
parameter | 接口所需的参数,为json数组 |
encryption | 是否加密,true:需要加密,false:不需加密 |
3、代码案例
如图所示,首先实例化OperationDataServiceImpl类,再调用execute()方法即可