向导模式生成API

发布日期：2025-01-04 10:32    点击次数：71

数据服务支持通过向导模式或脚本模式生成API，相对于脚本模式，您无需编码能力，可以可视化地配置API。本文为您介绍如何通过向导模式生成API。在生成API对话框中，配置各项参数。协议支持HTTP和HTTPS。如果您需要通过HTTPS协议调用API，请您发布API至网关后，在API网关控制台绑定独立域名，并上传SSL证书。详情请参见支持HTTPS。请求方式支持GET和POST。返回类型仅支持JSON返回类型。可见范围包括工作空间和私有： 工作空间：该API对本工作空间内的所有成员可见。私有：该API仅对API的负责人可见，且暂不支持授权。 标签从标签列表中选择相应的标签，详情请参见创建及管理API标签。 描述对API进行简要描述，不得超过2000个字符。目标文件夹存放API的目录，可以在下拉列表选择已创建的业务流程，选定后，会生成API的存放路径。默认格式为：“业务流程/业务流程名称/API”，例如业务流程/ceshi/API。单击确定。配置API双击打开API的编辑页面，在选择表区域，配置数据源类型、数据源名称、数据源环境、数据表名称等参数。在选择参数区域，设置请求参数和返回参数。您可以根据数据表中的指定字段对API的返回结果进行排序。当您的排序列表中有多个字段时，序号越小的字段，排序的优先级越高，您可以通过上移和下移操作来调整排序字段的优先级。对于每个排序字段，您均可以选择升序或降序的方式进行排序。单击API编辑页面右侧的请求参数，配置各项参数。参数描述参数名称请求参数的名称，支持英文、数字、下划线、连字符（-），且仅支持以英文开头，不能超过64个字符。绑定字段默认不可以修改。如果您需要修改绑定字段，请使用脚本模式。详情请参见：通过脚本模式生成API。参数类型包括STRING、INT、LONG、FLOAT、DOUBLE和BOOLEAN。参数位置包括QUERY和BODY。操作符操作符用于表示请求参数和实际赋值之间的关联和比较。您可以选择以下操作符： 等于：请求参数等于实际赋值。LIKE：为请求参数搜索某种指定模式。IN：为请求参数规定赋值集合。NOT IN：请求参数不在赋值集合中。NOT LIKE：请求参数不在该指定模式中。!=：请求参数不等于实际赋值。>：请求参数大于实际赋值。<：请求参数小于实际赋值。>=：请求参数大于或等于实际赋值。<=：请求参数小于或等于实际赋值。是否必填该请求参数是否必填。示例值该请求参数的示例值。默认值该请求参数的默认值。描述该请求参数的简要说明。单击API编辑页面右侧的返回参数，配置各项参数。配置返回参数。在高级配置区域，设置是否返回结果分页。配置过滤器。配置服务资源组。在API编辑页面的右侧导航栏中，单击服务资源组，您可以在资源组类型区域配置API调用时使用的资源组类型。在环境配置区域，您可设置内存、超时时间和单次请求数据条数上限。单击工具栏中的图标，保存API后，所选资源组将在测试时生效。发布API后，服务资源组的配置即可在调用API时生效。您还可以在服务开发页面左侧目录树中对目标API进行克隆和删除等操作。您也可以在服务管理页面，展开API列表，查看已发布API的详情。详情请参见查看、删除、移动、克隆、批量操作、代码搜索API转换向导模式为脚本模式您可以转换向导模式生成的API为脚本模式：在服务开发页面，展开目标API所在的业务流程 > API。双击相应的API名称，打开该API的编辑页面。单击工具栏中的图标。在提示对话框中，单击确认，您可以在编写查询SQL区域，查看转换后的SQL语句。