华为云首页用户手册

APPCUBE-如何开放API接口:如何定义API接口

APPCUBE-如何开放API接口:如何定义API接口

时间：2023-11-01 16:19:13

APPCUBE

如何定义API接口

在AppCube开发环境首页，单击某个应用，进入应用开发页面。
单击左下角的“服务”，进入服务管理页面。

图1 服务

图2 服务管理界面
- 私有接口：使用私有接口，您可以将服务编排的URL映射到内部网关，提供给内部脚本、服务编排等流程调用。对于BO可以定义私有接口。
- 公共接口：使用公共接口，您可以将服务编排、脚本或对象的URL映射到外部网关，第三方可以通过OAuth2.0调用。
- 内部网关：仅当前租户能够访问映射到内部网关中的自定义接口，即只有同一租户下的脚本、服务编排等才能调用发布的私有接口。
- 外部网关：其他租户或第三方系统均可访问映射到外部网关中的自定义接口。

单击“新建”，填写表1中参数，单击“保存”。

表1 API信息
参数名	参数说明
标签	API接口标签。
操作名称	API接口名称。
版本	API接口版本，格式为“x.y.z”。
URL	API接口路径，固定以 /service/{命名空间}__{应用名}/{版本} 开头，后面接API的具体路径。
内容类型	请求中的body类型。 application/json multipart/form-data binary-data “multipart/form-data”和“binary-data”用于文件上传接口，选择该内容类型，只能调用post类型的脚本。
分类	该接口所属的分类。选填项，直接输入。
描述	关于该自定义API的描述信息。
类型	选择资源类型，只有服务编排类型的接口能够在服务编排中被调用，其他类型接口只能通过API的形式进行调用。服务编排：表示该定义URL调用的接口类型是服务编排。脚本：表示该定义URL调用的接口类型是脚本。对象：表示该定义URL是操作对象数据，包括对象数据的增删改查。
自定义响应	是否需要格式化调用该URL后返回的响应消息。如果勾选，表示对响应消息进行格式化，删除resCode、resMsg、result外层信息，只透传返回的消息。例如，不勾选“自定义响应”，返回如下响应消息： { "resCode": "0", "resMsg": "成功", "result": [ { "equipments": [ { "createdBy": "aaa", "createdBy.__objectType": "User" }, { "createdBy": "aaa", "createdBy.__objectType": "User" } ], "total": "2" } ]} 则勾选“自定义响应”后，只返回如下响应消息： { "equipments": [ { "createdBy": "aaa", "createdBy.__objectType": "User" }, { "createdBy": "aaa", "createdBy.__objectType": "User" } ], "total": "2"}
资源	根据类型选定需要绑定的资源，如脚本，服务编排或者操作的对象名称。注意：如果您找不到想绑定的服务编排或脚本，请检查服务编排或脚本是否启用，如果没有启用请单击按钮启用。
对象操作	当“类型”选择为“对象”时，该参数才会显示。 Insert Record：新增对象数据。 Update or Insert Record：更新或者新增对象数据。 Update By ID：按记录ID更新对象数据。 Delete By ID：按记录ID删除对象数据。 Query By ID：按记录ID查询对象数据。 Update By Condition：按条件更新对象数据。 Delete By Condition：按条件删除对象数据。 Query By Condition：按条件查询对象数据。
方法	API接口的HTTP方法。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。

单击API接口列表操作栏按钮，查看定义的API信息。单击“测试一下”可模拟API接口调用。

图3 API接口请求参数信息

图4 API接口返回参数信息

API接口的请求参数和返回消息体，为绑定的资源（如脚本，服务编排等）所配置的入参和出参。

上一篇：APPCUBE-如何开放API接口:如何使用错误码

下一篇：APPCUBE-如何自定义错误码:如何使用自定义错误码

APPCUBE-如何开放API接口:如何定义API接口

意见反馈

0/200

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

推荐文章

解决方案
相关专题