iPaaS文档库 iPaaS文档库
00 概述
01 产品安装指南
02 快速入门指南
03 Studio使用指南
04 iPaaS使用指南
05 高级配置指南
06 接口服务说明
07 升级&数据迁移指南
08 产品集成指南
09 FAQ
  • API发布

# API发布

说明:使用数据库类型数据源时,需将对应数据库驱动部署至Portal和Server。
  1. 使用manager账号(默认密码:000000)登录系统,点击开发门户,进入“工作台”页面。

  2. “工作台”页面,在“我的系统”页签中,选择系统点击“API快速发布”。

  3. “API快速发布“弹窗,选择”DB“页签,点击”View转HTTP“按钮,进入”View发布“页面。

  4. ”View发布“页面,参考字段说明表格,填写“业务信息配置”页签中内容。

    参数 说明
    所属系统 API所属系统
    所属服务 API所属服务,若没有对应服务,点击服务下的新增创建服务
    接口名称 API接口名称
    接口编码 API接口编码
    数据源 需要发布的数据源,若没有对应数据源,请参考 步骤5 新增数据源
    选择视图 数据库中需要发布的视图
    接口描述 业务接口描述
  5. 若没有数据源,请点击“数据源”字段右下角“请新增”按钮,弹出“新增数据源”弹框。

    参考字段说明表格,填写数据源信息,点击“连通性测试”按钮,提示“连通成功”,点击“确定”按钮,保存数据源信息。

    参数 说明
    所属系统 数据源所属系统
    数据源编码 数据源编码
    数据源名称 数据源名称
    数据库类型 数据库类型,可选MySql、Oracle、PostgreSQL、SQLServer、DM、openGaussDB、GBase8a、HighGoDB、KingbaseES、UXDB、Oscar、GBase8s
    驱动程序 驱动程序驱动
    数据库账号 数据库账号
    数据库密码 数据库密码
    数据库IP 数据库服务器IP
    数据库端口 数据库端口
    数据库名称 数据库名称
    Schema 数据库Schema
    数据库URL 数据库URL
    连接池最大值 接池最大值
    连接池最小值 连接池最小值
    查询超时(s) 数据库查询超时时间,的那位秒
    读取超时(ms) 数据库读取超时,单位毫秒
    测试SQL语句 连接连通性测试SQL语句
  6. “业务信息配置”信息填写完成后,点击“下一步”按钮,进入“接口发布”页面,在接口发布页面填写相关参数,点击“发布”按钮,即可完成对视图的发布操作。

    参数 说明
    代理端口 接口发布的代理端口号
    代理URI 接口发布后的代理URI
    发布说明 发布说明
    视图别名 视图别名
    字段别名 字段别名
    条件字段 表数据的查询条件
    预览SQL语句 可预览SQL
    预览数据 数据预览
    选择服务器 接口发布的服务器
  7. 进入开发门户,点击菜单“API管理”>"我的发布",进入“我的发布”页面,选择左侧组织树中本章节新增API的所属系统,在右侧界面可查看本章节创建的视图转HTTP接口的发布记录。

    功能 说明
    接口名称 查看发布详情、API文档、API策略、API测试、API版本、API日志、发布说明
    接口状态 控制接口上线、下线
    编辑 已发布接口修改(修改后自动生成新版本并发布)
    删除 取消发布后可删除接口
    取消发布 将已发布接口进行取消发布
  8. 在列表中点击接口名称,展示接口详情。

← 2.4.3.3 API日志 2.4.4.2 API订阅 →