教程:创建 SOAP API

本教程将向您展示如何使用SOAP服务 Web服务定义语言(WSDL) 创建API定义。 此 API 定义可简化用于创建和管理 SOAP 服务访问权的过程。

关于本教程

按照本教程,通过导入现有SOAP 服务的WSDL ,在 API管理器中创建一个API。 API Connect 支持SOAP 1.1 和SOAP 1.2 标准。 在调用时,API 将从 API 调用程序提取 SOAP 请求,并将其用于生成自己的请求,并将请求发送给 SOAP 服务。 然后,API 会返回 SOAP 服务响应。 在本教程中,SOAP 服务返回特定用户的虚构银行账户的余额。

在本教程中,您将完成以下课程:
  1. 创建 SOAP API
  2. 测试 SOAP API

准备工作

注意: 沙盒目录必须配置为使用 DataPower® API GatewayDataPower Gateway (v5 compatible) 或两者。 请参阅创建和配置目录

创建 SOAP API

要为现有 SOAP 服务创建 API,请完成以下步骤。

  1. 下载 SOAP WSDL 文件 AccountServicing.txt。 将此文件重命名为 AccountServicing.wsdl
  2. 登录到 API管理界面
  3. 点击 “开发 ”图标。

    API管理器屏幕

  4. 点击 “添加” > “API”

    API 添加菜单

  5. 确保选择 OpenAPI 2.0
  6. 选择从现有 WSDL 服务(SOAP 代理)。 单击下一步

    WSDL确认屏幕

  7. 在“文件上载”部分中,拖放 AccountServicing.wsdl 文件,或者单击以从文件系统上载文件。

    WSDL文件上传界面

  8. 文件上传,并由 API Connect 解析。 此时会显示确认消息。 点击 “下一步 ”继续。
  9. 选中“ AccountServicing ”WSDL服务,然后单击 “下一步 ”。

    WSDL 服务屏幕

  10. “信息”部分保持数值不变,然后点击 “下一步 ”。

    API 信息

  11. “安全 ”部分,请确保已选中 “使用客户端 ID 进行安全验证 ”和“ CORS ”复选框。 单击 下一步

    API安全与发布

  12. 现在显示 “摘要 ”屏幕。

    结果摘要(顶部)

  13. 点击编辑API

    API信息页面

  14. 单击 “验证” > “按规范验证 ”。 您的 SOAP API 现已上线。信息

您已成功创建了一个 SOAP API。 WSDL 文件提供配置 API 输入和响应所需的所有信息。

测试 SOAP API

要测试 SOAP API,请完成以下步骤。

  1. 点击 AccountServicing API的 “测试 ”选项卡。
  2. 单击 “目标配置 ”以打开 “首选项 ”对话框。
  3. 启用 “自动发布” 设置,然后点击 “保存偏好设置 ”。 您会看到 API 现已上线,由一个绿色标记表示。目标配置
  4. “请求 ”下,点击 “发送 ”以测试 API。 将在“响应”部分中显示 API 响应。

您在本教程中执行的操作

在本教程中,您完成了以下活动:

  • 创建了 SOAP API 定义。
  • 测试了 SOAP API。