Skip to main content

API的使用

API的概念​

API(Application Programming Interface) 表示应用程序编程接口。

API，是一种可直接调用的接口，在该接口中已经配置了相关功能实现。本构件定义且只在本构件内实现的对外（构件方法）接口。

img

知识点回顾

1. 什么是构件方法？
构件级别的方法，不属于任何窗体，分为客户端方法和服务端方法。
2. 为什么要使用构件方法？
  • 为了实现代码重用。避免重复劳动,提高效率;
  • 减少需求变动影响的代码范围;
  • 保持系统的一致性;
  • 降低测试成本。
3. 什么是方法输入、输出、变量？
  • 方法输入：被调用时需要传入的参数；
  • 方法输出：被调用后返回的参数；
  • 方法变量：当前方法内部的参数。
4. 数据与输入输出
从数据的角度出发，我们可以简单理解：
  • 方法输出：查询、获取、返回等方法，被调用时需要返回结果(数据)的，需要设置方法输出。
  • 方法输入：新增，保存/更新，删除等方法，被调用时需要传入参数(数据)的，需要设置方法输入。

场景1：本构件内调用API接口​

案例下载

在本构件内实现表单的维护功能。

（1）定义API：在本构件内，定义构件方法（设置方法参数），配置表单的获取、删除和保存数据的API；

（2）调用API：在窗体中通过相关事件，结合“执行方法”规则，直接调用对应的API接口实现表单的维护功能。

实现步骤：本构件内定义接口，本构件内调用。

img

场景2：不同构件之间调用API接口​

案例下载

不同构件之间实现表单的维护功能。

（1）定义API：在A构件中定义表，定义构件方法配置表单的获取、删除和保存数据的API，设置方法输出和构件部署。

（2）调用API：在B构件中，引用A构件，结合“执行方法”规则，调用引用构件中的API接口实现表单的维护功能。

实现步骤：A本构件内定义接口（设置输出），B构件调用接口（引用构件）。

img