API开发

最近更新时间:2023-06-16 11:46:56

查看PDF
  1. 新建主题
    主题用于为API进行分类,点击新建主题按钮,进行主题创建。

  2. 新建API
    点击新建API按钮,选择归属主题后,可创建API。

  3. 选择查询模式
    API开发支持“单实例查询”“跨库查询”两种模式,当选择“跨库查询”时,可以选择引用缓存表进行开发。

  4. 数据预览
    待查询的数据表可通过左侧tab的数据预览功能进行提前预览

  5. 输入查询SQL及SQL格式化
    用户可以在【查询SQL】界面输入查询SQL语句, 运行过程中,可实时查看查询状态:已完成、查询中、查询异常
    点击格式化可对SQL进行格式化操作。

  6. 配置
    点击配置按钮,可配置API的API Path、请求参数、入参、出参等信息。

  7. 测试API
    配置保存后,点击测试按钮,输入参数测试值,即可对API进行测试。

  8. 提交生成API
    测试无误后,点击提交按钮,即可生成一个版本的API。
    备注:API支持多版本

  • API最新版本未发布注册API网关的:可编辑未发布的API版本;
  • API最新版本以发布注册API网关的,可编辑DEV版本生成新版本

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈