教程:创建调用现有 SOAP 服务的 REST API 定义

本教程向您展示如何公开现有的 SOAP 服务并将其返回的 XML 数据转换为指定的 JSON 数据。

关于本教程

按照本教程,通过导入现有 SOAP 服务的 WSDL ,在 API Manager 中创建 REST API。 API Connect 支持 SOAP 1.1 和 SOAP 1.2 标准。 调用时,API 返回特定用户的虚构银行账户的余额。

在本教程中,您将完成以下课程:
  1. 设置 REST API 定义
  2. 测试 API 定义

在开始之前

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

设置 REST API 定义

要设置调用现有 SOAP 服务的 REST API,请完成以下步骤。

  1. 下载 SOAP WSDL 文件 AccountServicing.txt。 将此文件重命名为 AccountServicing.wsdl
  2. 登录 API 管理器用户界面。
  3. 单击开发 API 和产品磁贴。

    应用程序接口管理器屏幕

  4. 单击添加 > API(REST、 GraphQL 或 SOAP)

    API 添加菜单

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

    创建 REST 代理

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

    WSDL 确认屏幕

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

    WSDL 服务屏幕

  10. 信息 "部分的值保持不变,然后单击 " 下一步 "。

    API 信息

  11. 在“安全”部分中,选择根据密钥限制 API 调用数复选框,并在“激活 API”部分中,选择激活 API 复选框。 单击下一步

    应用程序接口安全和发布

  12. 现在将显示“摘要”屏幕,其中显示创建和发布新 API 的步骤。 在此过程完成后,您将看到结果摘要,其中包括 API 基本端点,以及向新 API 自动预订的“沙箱测试应用程序”的凭证。

    结果摘要(顶部)

  13. 单击编辑 API。 您的新 API 现在已联机。

    设计页面(顶部)

您已成功创建调用现有 SOAP 服务的 REST API,并将其包含在准备用于测试的产品和计划中。 WSDL 文件提供配置 API 输入和响应所需的所有信息。

测试 API 定义

注意: 由于跨源资源共享 (CORS) 限制,汇编测试工具不能在 macOS Catalina 平台上与 Chrome 或 Safari 浏览器一起使用。

要使用 API 管理器测试工具测试您的 API 定义,请完成以下步骤。

  1. 单击 AccountServicing API 的 Assemble 选项卡,移至 Assemble 视图,然后单击 Test 图标 测试图标

    组合视图

    请注意,正在弃用测试面板,并且将在未来发行版中移至测试选项卡。

  2. 这样会打开“测试”面板,您可以看到其中列出测试设置所需的缺省产品和计划。

    测试窗格

  3. 操作部分,选择要调用的 /getBalance 后操作。

    选择操作

  4. 在“测试”面板中向下滚动至请求字段,然后单击生成以自动生成样本请求。

    生成申请

  5. 单击 " 调用 "测试 API。 将在“响应”部分中显示 API 响应。 如果收到与不可信证书相关的消息,请单击提供的链接,接受证书,然后返回至测试环境并再次单击调用

    成功调用

    响应”部分成功返回账户的余额。

您在本教程中执行的操作

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

  • 设置了 REST API 定义。
  • 根据 SOAP WSDL 文件配置了 API,以调用现有 Web Service 并返回其输出。
  • 测试了 API 定义。