反馈已提交

网络繁忙

2、API管理

  • 文档创建者:FineTube
  • 历史版本:1
  • 最近更新:FineTube 于 2021-10-18
  • API管理包含创建服务、创建API接收数据、创建API发布数据准备模块准备好的数据。


    1、创建服务

    ① 创建服务

    ② 填写服务名称

    ③ 保存创建的服务

    ④ 针对API服务,出于安全策略考虑,还可进行IP的黑白名单设置。路径:API管理>>对应服务>>编辑>>安全设置



    2、创建API接收数据

    ① 创建API服务用于接收数据。

    2.1 请求配置

    ② 自定义服务名称

    ③ 自定义Path,点击Path后的”获取完整URL“,则可通过其url进行数据的获取:http://IP:14114/dataway/service/demo接收数据

    ④ Method:统一采用POST方式

    2.2 响应配置

    可以基于请求成功和失败分别返回不同的值,支持新增自定义key。

    2.3 输出配置

    kafka和系统日志,二选一。

    ⑤ 完成kafka地址的配置后,可点击测试链接,确认kafka可用。

    ⑥ 勾选系统日志后,默认INFO级别日志输出,另外可支持WARN、ERROR模式的日志输出。


    3、创建API发布数据

    步骤:

    1、创建需要对外提供数据的数据集

    2、创建对外提供的API服务和数据集进行绑定

    3、API发布以及下线

    3.1 创建数据集

    参考:1、数据准备 - FineTube帮助文档

    3.2 创建API以及数据绑定

    目录:数据服务>>API管理>>创建服务>>创建API>>发布数据

    ① 请求配置

    点击Path后的”获取完整URL“,则可通过其url进行数据的获取。


    ② 响应配置

    此页面支持对请求成功时、失败时,返回对应的值,同时也支持自定义添加。


    ③查询配置

    若在3.1 已经完成数据集的创建,则在此处可直接进行选择对应业务包下的数据集,若没有需要发布的数据集,则进行新建。

    3.3 API的发布和下线

    在完成了API配置操作后,则可对对应的API任务进行发布。

    3.4 数据验证

    打开常用工具postman,新建一个Requet页面,Method选择POST, 输入4.2 中的url链接,由于Body不能为空,在Body配置处任意输入,再进行点击Send,预览如下:

    附件列表


    主题: 模块介绍
    已经是第一篇
    已经是最后一篇
    • 有帮助
    • 没帮助
    • 只是浏览

    售前咨询电话

    400-811-8890转1

    在线技术支持

    热线电话:400-811-8890转2

    总裁办24H投诉

    热线电话:173-1278-1526

    文 档反 馈

    鼠标选中内容,快速反馈问题

    鼠标选中存在疑惑的内容,即可快速反馈问题,我们将会跟进处理。

    不再提示

    10s后关闭