如何为对象自定义API

使用说明

当系统提供的基本操作无法满足需求时，可通过自定义API来实现。

图1 查看操作类型

操作步骤

1. 在业务设计页面，选中某个业务对象。
2. 单击BO属性操作中的“自定义API”，进入编辑自定义API页面。
3. 单击，按需添加所需的API。
   图2 添加API
   
   • 实例级别：定义API实例的级别，如类型、实例。
   • 动作名称：设置API的动作名称。
   • 请求方法：HTTP请求方法（也称为操作或动作），用于告诉服务您正在请求什么类型的操作。
     • get：请求服务器返回指定资源。
     • put：请求服务器更新指定资源。
     • post：请求服务器新增资源或执行特殊操作。
     • delete：请求服务器删除指定资源。
   • 请求对象：设置请求的对象，即API请求的输入参数。
   • 返回对象：请求发送后，您会收到的响应，如状态码。
   • 路径：添加API的路径，格式为变量放到“{}”中，单词用“_”连接，非变量单词用“-”连接。
   • 描述：自定义API的描述信息，按需进行设置。

4. 设置完成后，单击“保存”。