导入和发布第一个 API

本教程介绍如何导入 http://conferenceapi.azurewebsites.cn?format=json 中的“OpenAPI 规范”后端 API。 此后端 API 由 Microsoft 提供并托管在 Azure 上。

后端 API 导入到 API 管理 (APIM) 之后,APIM API 即成为后端 API 的外观。 在导入后端 API 时,源 API 和 APIM API 均相同。 通过 APIM,无需触摸后端 API 即可根据需要自定义外观。 有关详细信息,请参阅转换和保护 API

本教程介绍如何执行下列操作:

  • 导入第一个 API
  • 在 Azure 门户中测试 API
  • 在开发人员门户中测试 API

新的 API

先决条件

完成以下快速入门:创建 Azure API 管理实例

若要导航到 APIM 实例,请执行以下步骤:

  1. 登录到 Azure 门户
  2. 选择 箭头
  3. 在搜索框中键入“api”。
  4. 单击“API 管理服务”。

    导航

  5. 选择 APIM 服务实例。

Tip

在 Azure 门户中通过单击星形将 API 管理 (APIM) 添加到收藏夹。
这会在门户左侧的菜单中添加“APIM”图标。 若要查看所有 APIM 服务,请单击该图标(“APIM”图标)。

导入和发布后端 API

本部分演示如何导入和发布 OpenAPI 规范后端 API。

  1. 在“API 管理”下面选择“API”。
  2. 从列表中选择“OpenAPI 规范”。

    创建 API

    可在创建时设置 API 或稍后转到“设置”选项卡进行设置。带有红色星号的字段是必填的。

    使用下表中的值创建第一个 API。

    设置 说明
    OpenAPI 规范 http://conferenceapi.azurewebsites.net?format=json 引用实现 API 的服务。 API 管理将请求转发到此地址。
    显示名称 演示会议 API 如果在输入服务 URL 后按 Tab 键,APIM 将根据 json 中的内容填充此字段。
    此名称显示在开发人员门户中。
    名称 demo-conference-api 提供 API 的唯一名称。
    如果在输入服务 URL 后按 Tab 键,APIM 将根据 json 中的内容填充此字段。
    说明 提供 API 的可选说明。 如果在输入服务 URL 后按 Tab 键,APIM 将根据 json 中的内容填充此字段。
    URL 方案 HTTPS 确定可用于访问 API 的协议。
    API URL 后缀 会议 此后缀附加到 API 管理服务的基础 URL。 API 管理通过其后缀区分 API,因此后缀对于给定发布者的每个 API 必须唯一。
    产品 不受限制 产品是一个或多个 API 的关联。 可在一个产品中包含多个 API,并通过开发人员门户将其提供给开发人员。
    通过将 API 关联到某个产品(在本示例中为“无限制”)来发布该 API。 若要将此新 API 添加到产品,请键入产品名称(也可以稍后通过“设置”页执行此操作)。 可以多次重复此步骤,将此 API 添加到多个产品。
    开发人员必须先订阅产品才能访问 API。 订阅时,他们会得到一个订阅密钥,此密钥对该产品中的任何 API 都有效。
    如果你创建了 APIM 实例,那么你已是管理员,因此订阅了每个产品。
    每个 API 管理实例默认附带两个示例产品:“入门”和“无限制”。
    对此 API 进行版本控制? 有关版本控制的详细信息,请参阅发布 API 的多个版本

    Note

    若要发布 API,必须将其与某个产品相关联。 可以从“设置”页执行此操作。

  3. 选择“创建” 。

在 Azure 门户中测试新的 APIM API

可直接从 Azure 门户调用操作,这样可以方便地查看和测试 API 的操作。

  1. 从“API”选项卡选择在上一步骤中创建的 API。
  2. 按“测试”选项卡。

    测试 API

  3. 单击“GetSpeakers”。

    该页显示查询参数(在此示例中无)和标头的字段。 其中一个标头是“Ocp-Apim-Subscription-Key”,适用于和此 API 关联的产品订阅密钥。 将自动填充该密钥。

  4. 按“发送”。

    后端以“200 正常”和某些数据做出响应。

从开发人员门户调用操作

此外,也可以从开发人员门户调用操作来测试 API。

  1. 导航到开发人员门户

    开发人员门户

  2. 选择 API,依次单击“演示会议 API”和 GetSpeakers

    该页显示查询参数(在此示例中无)和标头的字段。 其中一个标头是“Ocp-Apim-Subscription-Key”,适用于和此 API 关联的产品订阅密钥。 如果创建了 APIM 实例,那么你已是管理员,因此会自动填充该密钥。

  3. 按“试用”。

  4. 按“发送”。

    调用操作后,开发人员门户将显示响应。

后续步骤

在本教程中,你已学习了如何执行以下操作:

  • 导入第一个 API
  • 在 Azure 门户中测试 API
  • 在开发人员门户中测试 API

转到下一教程: