生成API

生成API是新增API的方式之一,包括模板向导模式和自定义SQL模式。

适用场景

模板向导模式生成API:通过勾选的方式配置单张表的原生字段从而快速生成API,可视化易上手。适合单张表的简单逻辑查询。

Summary 向导模式概览

自定义SQL模式生成API:通过书写SQL代码的方式配置API,灵活自定义。支持多张表关联输出、复杂查询条件及聚合函数操作等,适合具有一定经验的数据开发使用。

Summary SQL自定义模式概览

流程说明

通过模板向导模式和自定义SQL模式生成API均需进行以下步骤。

第一步:进入配置入口,用户进入顶部的「API管理」菜单,点击左侧的「API管理-API」,点击「新增API」按钮。

第二步:API基本配置,例如类目地址、名称、path、协议、安全限制等等。

第三步:配置API参数,两种模式的配置内容差别较大。

第四步:在线测试,用户可根据测试结果判断逻辑设置是否正确。

第五步:在线测试完成后,用户可前往API提交与发布中提交API至API网关,提交成功后可前往API签名选择鉴权方式,生成请求头。随后查看API测试使用第三方工具对API进行外部测试,检查API的可用性。