其他目录选项

目录的其他配置选项。

转移目录所有权

要将目录的所有权转移给其他用户,请执行以下步骤:

  1. 单击 目录设置 ,然后选择 概述
  2. 单击编辑
  3. 选择所有者用户中,选择将成为新所有者的用户。
  4. 如果在目录中启用了空间,那么还要将目录中所有空间的所有权转移给新的目录所有者,请选择 同时转移所拥有空间的所有权
  5. 单击 保存 以保存更改。
注:
  • 要具有更改目录所有者的许可权,您必须是目录所有者或包含目录的提供者组织的所有者。
  • 当所有权发生更改时,将为新所有者分配目录的管理特权,并且将除去先前所有者的管理特权。 如果需要,您可以将特权复原到先前所有者,如 管理目录成员资格中所述。
  • 只能将所有权转移给已经是目录成员的用户。 要传输到新用户或其他现有用户,该用户必须先前已添加或邀请到目录,如 管理目录成员资格中所述。

配置发布验证

要配置发布产品时执行的发布验证,请执行以下步骤:

  1. 单击 目录设置 ,然后选择 发布验证
  2. 单击 编辑,然后根据需要选中或清除验证复选框。
    注: 可以选择以下验证选项:
    • 不允许发布具有空路径的 API
    • 验证组合件中的定制策略模式
    • 验证 API 中的引用并执行其他 OpenAPI 验证
    • 不允许发布具有重复基本路径的 API
  3. 单击 保存 以保存更改。

配置虚 API 端点

对于任何 API,可以考虑两个可能的端点:
  • 调用 API 的网关端点。
  • Developer Portal中的使用者可见的端点。
如果不配置虚端点,那么这两个端点相同,并指向调用 API 的网关端点。

要使端点对与网关端点不同的使用者可视,请配置虚端点。 虚端点表示外部已知 API 的端点; 即,发布到 Developer Portal 并由应用程序开发者用于调用 API 的端点。 确定 API 网关端点的方式取决于 API 的 OpenAPI 版本,如下所示:

(OpenAPI 2.0): 对于 API Connect中的任何强制实施的 API , API 的网关端点格式如下所示:
  • 如果 OpenAPI 定义无 host 字段,那么 API 端点具有以下格式:
    https://gateway_service_host/provider_organization/catalog/basepath
  • 如果 OpenAPI 定义具有 host 字段(例如,petstore.com),那么 host 将附加到路径 provider_organization/catalog 段之后,并且 API 端点具有以下格式:
    https://gateway_service_host/provider_organization/catalog/host_field_value/basepath
    注: 这是来自 IBM® API Connect Version 5.0的行为更改,其中 host 字段未包含在 API 端点中。
在这些端点 URL 中,变量如下所示:
  • gateway_service_host 是运行 API 的网关服务的主机名。
  • provider_organization 是包含在其中发布 API 的目录的提供者组织的 name 字段值。
  • catalog 是在其中发布 API 的目录的 name 字段值。
  • basepath 是 API 的 OpenAPI 定义中的 basepath 字段值。
  • host_field_value 是 API 的 OpenAPI 定义中的 host 字段值。
有关在 OpenAPI 2.0 API 定义中配置主机服务器 URL 的详细信息,请参阅 指定 API 的主机
仅 DataPower API Gateway(OpenAPI 3.0): 如果 API 由 DataPower® API Gateway实施,那么将使用为 API 的 OpenAPI 定义中 servers 数组中的第一个 url 条目指定的值来确定 API 端点的 basepath 元素,如下所示:
  1. 如果为服务器 URL 指定了相对 URL,那么该值将按原样用于 basepath,并且 API 端点具有以下格式:
    https://gateway_service_host/provider_organization/catalog/basepath
  2. 如果为服务器 URL 指定了完整 URL ,那么 DataPower API Gateway将忽略方案 (http://https://) ,并使用剩余的主机名和 basepath 来构成 API 端点,如下所示:
    https://gateway_service_host/provider_organization/catalog/host_name/basepath
在这些端点 URL 中,变量如下所示:
  • gateway_service_host 是运行 API 的网关服务的主机名。
  • provider_organization 是包含在其中发布 API 的目录的提供者组织的 name 字段值。
  • catalog 是在其中发布 API 的目录的 name 字段值。
  • host_name 是服务器 URL 中主机名的值。
  • basepath 是从服务器 URL 派生的 basepath 的值。
有关在 OpenAPI 3.0 API 定义中配置服务器 URL 的详细信息,请参阅 为 API 定义服务器为路径定义服务器为操作定义服务器
注: 您可以更改目录设置以使用 IBM API Connect Version 5.0 端点行为,包括对称为 主机到目录映射的功能部件的支持,由此可以调用 API ,而不必在 URL 路径中包含提供者组织或目录; 请参阅 保留目录中的版本 5 虚端点行为

要配置虚 API 端点,以便可以发布不同于这些网关端点的端点,请完成以下步骤:

  1. 单击“目录设置”导航窗格中的 API 端点。 此时会打开“虚 API 端点”页面。
  2. 单击编辑
  3. 要显示当前 API 基本端点设置,请选择显示虚端点
  4. 选择所需的 首选项 设置。 选择以下设置之一:
    • 目录优先级:忽略 API 的 OpenAPI 定义中定义的任何主机,所有 API 端点始终指向您在此处定义的端点。 例如,假设您定义了一个虚 API 端点,其目录优先级首选项为 https://prod.acme.com/, 那么,API 端点将为 https://prod.acme.com/basepath
      确定 basepath 的方式取决于 API 的 OpenAPI 版本,如下所示:
      • (OpenAPI 2.0):basepath 取自 OpenAPI 定义中的 basepath 字段。
      • 仅 DataPower API Gateway(OpenAPI 3.0): basepath 取自 OpenAPI 定义中 servers 数组中的第一个 url 条目,忽略任何方案 (http://https://) 和主机名。
    • API 优先级:在 API 的 OpenAPI 定义中定义的主机优先。 例如,假设您定义了一个虚 API 端点,其 API 优先级首选项为 https://api.acme.com/, 那么将通过以下规则来确定调用 API 时使用的端点:
      • 如果在 OpenAPI 定义中定义了主机(例如,test.acme.com),那么该值用于确定 API 端点。 例如:https://test.acme.com/basepath
      • 如果在 OpenAPI 定义中未定义主机,那么 API 端点将为 https://api.acme.com/basepath,由虚 API 端点设置确定。
      确定任何已定义主机的方式取决于 API 的 OpenAPI 版本,如下所示:
      • (OpenAPI 2.0):主机取自 OpenAPI 定义中的 host 字段。
      • 仅 DataPower API Gateway(OpenAPI 3.0): 主机取自 OpenAPI 定义中 servers 数组的第一个 url 条目中的主机名。
  5. 提供一个或多个端点,如下所示:
    • 如果选择了目录优先级,请单击添加以 输入一个或多个端点 URL 以及每个端点 URL 的可选摘要。 可使用任何端点 URL 来调用 API。
    • 如果选择了 API 优先级,请输入端点 URL 和可选摘要。
注: 配置目录以支持虚 URL 之后,必须配置外部网络以将虚端点映射到相应的网关端点。 这通常包括以下配置:
  • DNS 映射,用于确保虚主机解析到网关。
  • API 路由的其他 URL(根据需要)。
例如,如果网关的缺省域名为 apigw.dc.zone.mycompany.com 且 IP 地址为 29.12.141.150,那么通用 DNS 配置可能为如下所示:
api.acme.com. CNAME apigw.dc.zone.mycompany.com.
api.acme.com. A 29.12.141.150

请咨询网络管理员或参考 DNS 提供商文档来执行此配置。