将 SOAP API 导入 API Management

2025-05-20

适用于：所有 API 管理层级

本文介绍如何导入 WSDL 规范（SOAP API 的标准 XML 表示形式）。本文还介绍如何在 API Management 中测试 API。

在本文中，学习如何：

导入 SOAP API
在 Azure 门户中测试 API

注意

WSDL 导入 API Management 受到某些限制的约束。不支持带有 wsdl:import、xsd:import 和 xsd:include 指令的 WSDL 文件。如需用于解析和合并 WSDL 文件中的这些依赖项的开放源代码工具，请参阅 GitHub 存储库。

先决条件

API 管理实例。如果你还没有 API 管理服务实例，请完成以下快速入门：创建 Azure API 管理实例。
Azure 命令行接口 (CLI)
- 在 Azure Cloud Shell 中使用 Bash 环境。有关详细信息，请参阅 Azure Cloud Shell 入门。
- 如需在本地运行 CLI 参考命令，请安装 Azure CLI。如果在 Windows 或 macOS 上运行，请考虑在 Docker 容器中运行 Azure CLI。有关详细信息，请参阅如何在 Docker 容器中运行 Azure CLI。
  - 如果使用的是本地安装，请使用 az login 命令登录 Azure CLI。若要完成身份验证过程，请遵循终端中显示的步骤。有关其他登录选项，请参阅使用 Azure CLI 向 Azure 进行身份验证。
  - 出现提示时，请在首次使用时安装 Azure CLI 扩展。有关扩展的详细信息，请参阅使用和管理 Azure CLI 中的扩展。
  - 运行 az version 以查找安装的版本和依赖库。若要升级到最新版本，请运行 az upgrade。
Azure PowerShell
- 如果选择在本地使用 Azure PowerShell：
  - 安装最新版本的 Az PowerShell 模块。
  - 使用 Connect-AzAccount cmdlet 连接到 Azure 帐户。
- 如果选择使用 Azure Cloud Shell：
  - 有关详细信息，请参阅 Azure Cloud Shell 概述。

导入后端 API

在 Azure 门户，导航到 API 管理实例。
在左侧菜单中，选择“API”“+ 添加 API”。
在“根据定义创建”下，选择“WSDL”。
在“WSDL 规范”中，输入 SOAP API 的 URL，或单击“选择文件”以选择本地 WSDL 文件。
在“导入方法”中，默认情况下会选择“SOAP 直通”。选择此选项后，API 将公开为 SOAP，API 使用者必须使用 SOAP 规则。若要“REST 化”API，请按照导入 SOAP API 并将其转换为 REST 中的步骤进行操作。
以下 API 设置会基于 SOAP API 的信息进行自动填充：显示名称、名称、说明。操作会自动填充“显示名称”、“URL”和“说明”，并接收系统生成的“名称”。
输入其他 API 设置。可以在创建过程中设置这些值，也可以稍后转到“设置”选项卡来配置这些值。

有关 API 设置的更多信息，请参阅导入和发布你的第一个 API 教程。
选择“创建”。

以下示例使用 az apim api import 命令将 WSDL 规范从指定的 URL 导入到名为 apim-hello-world 的 API 管理实例。若要使用规范的路径而不是 URL 进行导入，请使用 --specification-path 参数。

对于此示例 WSDL，服务名称为 OrdersAPI，其中一个可用的终结点（接口）为“基本”。

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="order-api"
APIPath="order"
SpecificationFormat="Wsdl"
SpecificationURL="https://fazioapisoap.azurewebsites.net/FazioService.svc?singleWsdl"
WsdlServiceName="OrdersAPI"
WsdlEndpointName="basic"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --specification-format $SpecificationFormat --specification-url $SpecificationURL \
    --wsdl-service-name $WsdlServiceName --wsdl-endpoint-name $WsdlEndpointName

以下示例使用 Import-AzApiManagementApi Azure PowerShell cmdlet 将 WSDL 规范从指定的 URL 导入到名为 apim-hello-world 的 API 管理实例。若要使用规范的路径而不是 URL 进行导入，请使用 -SpecificationPath 参数。

对于此示例 WSDL，服务名称为 OrdersAPI，其中一个可用的终结点（接口）为“基本”。

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific det
$apiId = "orders-api"
$apiPath = "orders"
$specificationFormat = "Wsdl"
$specificationUrl = "https://fazioapisoap.azurewebsites.net/FazioService.svc?singleWsdl"
$wsdlServiceName = "OrdersAPI"
$wsdlEndpointName = "basic"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath -WsdlServiceName $wsdlServiceName -WsdlEndpointName $wsdlEndpointName

在门户中测试新的 API

可直接从管理门户调用操作，这为管理员查看和测试 API 的操作提供了一种方便的方式。

选择上一步中创建的 API。
选择“测试”选项卡。
选择操作。该页将显示查询参数的字段和标头的字段。

注意

在测试控制台中，API 管理自动填充 Ocp-Apim-Subscription-Key 标头，并配置内置全访问订阅的订阅密钥。此密钥允许访问 API 管理实例中的每个 API。可选择性地通过选择 HTTP 请求旁的“眼睛”图标来显示 Ocp-Apim-Subscription-Key 标头。
根据操作，输入查询参数值、标头值或请求正文。选择“发送”。

当测试成功时，后端会使用成功的 HTTP 响应代码和某些数据进行响应。

提示

默认情况下，测试控制台会将请求发送到 API 管理的 CORS 代理，该代理将请求转发到 API 管理实例，后者又将请求转发到后端。此代理使用公共 IP 地址 13.91.254.72，并且只能访问公共终结点。如果要将请求直接从浏览器发送到API 管理服务，请选择“绕过 CORS 代理”。如果要使用测试控制台，并且 API 管理网关与网络隔离或不允许来自 CORS 代理的流量，请使用此选项。

若要调试 API，请参阅教程：使用请求跟踪调试 API。

通配符 SOAP 操作

如果需要传递 API 中未定义专用操作的 SOAP 请求，可以配置通配符 SOAP 操作。通配符操作将匹配 API 中未定义的任何 SOAP 请求。

定义通配符 SOAP 操作：

在门户中，选择上一步创建的 API。
在“设计”选项卡中，选择“+ 添加操作”。
输入该操作的显示名称。
在 URL 中，选择 POST，并在资源中输入 /?soapAction={any}。花括号内为任意模板参数，不会影响到执行。

注意

请勿在“设计”选项卡中使用 OpenAPI 规范编辑器来修改 SOAP API。

追加其他 API

可以通过不同服务公开的 API 撰写 API，包括：

OpenAPI 规范
SOAP API
GraphQL API
Azure 应用服务中托管的 Web 应用
Azure Functions（Azure 功能服务）
Azure 逻辑应用
Azure Service Fabric

注意

导入一个 API 时，操作会追加到当前 API。

将 API 追加到现有 API：

在 Azure 门户中转到你的 Azure API 管理实例：
在“概述”页上选择“API”，或在左侧菜单中选择“API”“API”>。
选择要将另一个 API 追加到的 API 旁边的省略号 (...)。
从下拉菜单中选择“导入”：
选择要从中导入 API 的服务。

通过