WebAPI登记介绍

变更记录

产品版本	更新内容	更新日期
V5.0.17	初始版本	2023年02月15日
V5.0.20	优化WebApi登记功能，界面新增启用禁用功能按钮且脚本执行工具可选择WebApi登记作为依赖资源，丰富了webapi可调用场景。	2023年04月17日
V5.0.23	增加Relogin函数使用说明	2023年6月27日
V6.0.12	增加请求信息插入变量功能	2024年5月17日
V6.014	增加multipart/form-data报文格式支持、支持Swagger导入、支持发布到开放平台	2024年6月18日
V7.0	测试的时候支持填写请求头和url参数	2024年7月25日

1 简介

1.1 功能介绍

该功能用于快速登记外部系统的API到苍穹中，从而能够在苍穹中调用外部系统的接口。

功能列表：

1.2 应用场景

用户希望苍穹通过WebAPI与第三方系统进行集成时，可以使用该功能。

1.3 系统路径

【集成服务云】→【集成管理】→【API集成】 →【WebAPI登记】

1.4 关键字段/按钮说明

关键字段说明

字段名称	详细解释
数据源	在【连接管理】->【数据源管理】中创建，用于确定该WebAPI访问的系统信息，在配置API时可以引用这些连接信息
URL路径	WebAPI调用路径，与协议、ip、端口构成完成调用路径

关键按钮说明

按钮名称	详细解释
curl导入	上传curl文件或直接粘贴curl脚本，自动登记WebAPI
Swagger导入	上传Swagger文件或者直接粘贴脚本，自动登记WebAPI
生成示例代码	根据登记的WebAPI自动生成curl脚本
脚本模式	根据登记的WebAPI自动生成调用脚本，可根据需求在脚本中进行定制化处理
启用/禁用	启用状态下可以进行API测试和调试，且无法删除API；导入API默认为禁用状态
插入变量	在请求信息功能 url路径处添加该按钮，供快速选择连接变量

2 主要操作

2.1 根据curl自动创建

前提条件

已经创建了WebAPI类型的连接配置和数据源。

操作步骤

在postman中调通的WebAPI可以导出curl文件，并在WebAPI登记列表页面通过点击按钮“curl导入”导入自动生成API模型。

注：按钮“curl导入”下拉“下拉按钮'新增'”后可见。

2.2 支持Swagger导入

注：按钮“Swagger导入”下拉“下拉按钮'新增'”后可见。

2.3 手工创建

前提条件

已经创建了WebAPI类型的连接配置和数据源。

操作步骤

步骤1：首先，选择数据源，点击“新增”按钮，并补充完整WebAPI的调用url及请求信息。

注：如果报文格式为multipart/form-data，需要打开配置项中的'multipart/form-data'开关，具体使用方法参考multipart/form-data传送苍穹附件

步骤2：对于请求过程的参数信息，可以双击“URL参数”面板中的“参数值”单元格，选择对应变量，填充参数值。

注：此处的变量既连接配置上的字段信息以及登录脚本返回的鉴权信息。

步骤3：开启“格式化响应结果”，并根据响应体自动生成响应数据模型，响应后的数据模型在“响应结果”面板中可见。

步骤4：然后，保存登记信息。如果需要对整个调用过程进行额外调整，还可以开启“脚本模式”，可以对调用原始脚本进行修改，以符合需求。开启“脚本模式”模式后，可以在“请求脚本”面板中查看具