练习 - 导入和发布 API

  • 5 分钟

设置网关后，即可导入和发布 API，以便合作伙伴可以访问库存和产品信息。

你将在此处导入公开 OpenAPI 终结点的 Web API。 然后，使用可视化效果测试导入的 API。 最后，发布 API。

注意

本练习将使用你在上一练习中设置的资源。

导入 API

本练习的第一部分是将 NorthWind Shoes API 导入 API 管理网关。

  1. 在 Azure 门户资源菜单中或从主页中，选择“所有资源”，然后选择你的 API 管理服务。

  2. 在“API 管理服务”菜单的“API”下，依次选择“API”和“+ 添加 API”。

  3. 在“从定义创建”下，选择“OpenAPI”。 此时将显示“基于 OpenAPI 规范创建”窗格。

    添加新 API。

  4. 在 OpenAPI 规范窗口中，完成以下设置：

    设置 值
    OpenAPI 规范 粘贴从上一练习中保存的 Swagger JSON URL。
    显示名称 接受默认值，它应为 NorthWindShoes Products。
    名称 接受默认值，它应为 northwindshoes-products。
    API URL 后缀 忽略此设置。
    基 URL 接受默认值。

    注意

    你会注意到，输入 JSON URL 后，系统会自动填充其他几个字段。 这是因为我们使用了 OpenAPI，它指定了所有必需的连接详细信息。

  5. 选择“创建” 。 “apim-NorthwindShoesNNNN | API”窗格显示 NorthWindShoes 产品 API 的所有操作。

可视化 API

本练习的最后一个部分是测试 API 以及使用两个测试将结果可视化。 首先发出一个基本 GET 请求，它在单个参数中传递。

  1. 在“apim-NorthwindShoesNNNN | API ”窗格上，选择“NorthWindShoes 产品 API”，然后选择“测试”选项卡。

  2. 选择第一个 GET 操作，即“查找指定产品的详细信息”。 详细信息将显示在测试控制台中。

  3. 在“模板参数”下，输入产品 ID 参数的数值。

    突出显示产品 ID 值的测试窗格。

  4. 向下滚动，可发现“请求 URL”包含 后缀。

  5. 选择“ 发送”。

    对于 GET 请求，你应会收到“200 OK”响应，还会收到输入的产品 ID 的详细信息。

    现在，使用没有任何参数的基本 GET 请求进行测试。

  6. 选择第三个 GET 操作（即“检索公司的整个产品库存”），并确保选择“测试”选项卡。

    具有第三个 GET 请求的测试窗格。

  7. 向下滚动，可发现“请求 URL”包含 后缀。

  8. 选择“ 发送”。

    对于 GET 请求，你应会收到“200 OK”响应，还会收到有效负载中所有产品的库存（库存级别）的详细信息。