教程:创建和发布产品

在 Azure API 管理中,一个产品包含一个或多个 API 以及使用配额和使用条款。 发布产品之后,开发人员可订阅该产品,并开始使用产品的 API。

在本教程中,你将了解如何执行以下操作:

  • 创建和发布产品
  • 将 API 添加到产品
  • 访问产品 API

API Management products in portal

先决条件

创建和发布产品

  1. 登录到 Azure 门户,并导航到 API 管理实例。

  2. 在左侧导航窗格中,选择“产品”>“+ 添加”。

    Add product in Azure portal

  3. 在“添加产品”窗口中,输入下表中描述的值以创建产品。

    Add product window

    名称 说明
    显示名称 要在开发人员门户中显示的名称。
    说明 提供有关该产品的信息,如其用途、它提供访问权的 API 和其他详细信息。
    州省/自治区/直辖市 如果希望发布该产品,请选择“发布”。 在产品中的 API 可调用前,必须先发布该产品。 默认情况下新产品未发布,并仅对“管理员”组可见。
    需要订阅 如果用户需要订阅才能使用产品(产品受保护)并且必须使用订阅密钥才能访问产品的 API,请选择该项。 如果不需要订阅(产品开放),则无需订阅密钥即可访问产品的 API。 请参阅本文后面的访问产品 API
    需要批准 如果希望管理员审查并接受或拒绝此产品的订阅尝试,请选中该项。 如果未选中此项,则会自动批准订阅尝试。
    订阅计数限制 (可选)限制多个同步订阅的计数。
    法律条款 可以包含产品的使用条款,订阅者必须接受这些条款才能使用该产品。
    API 选择一个或多个 API。 还可以在创建产品后添加 API。 有关详细信息,请参阅本文稍后的将 API 添加到产品

    如果产品是开放的(不需要订阅),则只能添加不与另一个开放产品关联的 API。
  4. 选择“创建”以创建新产品。

注意

在配置不需要订阅的产品时,请小心。 此配置可能过于宽松,并且可能会使产品的 API 更容易受到某些 API 安全威胁的影响。

添加更多配置

保存产品后继续对其进行配置。 在 API 管理实例中,从“产品”窗口中选择产品。 添加或更新:

说明
设置 产品元数据和状态
API 与产品关联的 API
策略 应用于产品 API 的策略
访问控制 对开发人员或来宾可见的产品
订阅 产品订阅者

将 API 添加到产品

产品是一个或多个 API 的关联。 可包含许多 API,并通过开发人员门户将其提供给开发人员。 可以在创建产品期间添加一个或多个现有的 API。 之后,也可以通过产品的“设置”页或在创建 API 时将 API 添加到产品。

将 API 添加到现有产品

  1. 在 API 管理实例的左侧导航栏中,选择“产品”。
  2. 选择一个产品,然后选择“API”。
  3. 选择“+ 添加 API”。
  4. 选择一个或多个 API,然后点击“选择”。

Add an API to an existing product

访问产品 API

发布产品后,开发人员可以访问 API。 根据产品的配置方式,他们可能需要先订阅产品才能访问该产品。

  • 受保护的产品 - 开发人员必须先订阅受保护的产品才能访问该产品的 API。 订阅时,他们会得到一个订阅密钥,该密钥可以访问该产品中的任何 API。 如果你创建了 API 管理实例,那么你已是管理员,因此默认情况下订阅了每个产品。 有关详细信息,请参阅 Azure API 管理中的订阅

    当客户端使用有效的产品订阅密钥发出 API 请求时,API 管理会处理该请求并允许在产品上下文中进行访问。 可应用为产品配置的策略和访问控制规则。

    提示

    可以通过 REST API 或 PowerShell 命令使用自定义订阅密钥来创建或更新用户对产品的订阅。

  • 开放产品 - 开发人员无需订阅密钥即可访问开放产品的 API。 不过,你可以配置其他机制来保护客户端对 API 的访问,包括 OAuth 2.0客户端证书限制调用方 IP 地址

    注意

    开放产品未列在开发人员门户中供开发人员了解或订阅。 它们仅对“管理员”组可见。 你需要使用另一种机制来通知开发人员无需订阅密钥即可访问的 API。

    当客户端在没有订阅密钥的情况下发出 API 请求时:

    • API 管理会检查 API 是否与开放产品相关联。 一个 API 最多可与一个打开的产品关联。

    • 如果开放产品存在,则它会在该开放产品的上下文中处理请求。 可应用为开放产品配置的策略和访问控制规则。

有关详细信息,请参阅 API 管理在有或没有订阅密钥的情况下如何处理请求

后续步骤

在本教程中,你将了解:

  • 创建和发布产品
  • 将 API 添加到产品
  • 访问产品 API

转到下一教程: