创建和配置目录

如何在 IBM® API Connect中创建和配置目录。

要创建和配置目录，请完成以下步骤：

1. 登录 API 管理器并单击 Manage。
2. 创建目录。
   您可以通过以下任一方式创建目录：

   指定所有者，然后按下文所述配置目录。

   1. 单击添加 > 创建目录。
   2. 在目录所有者字段中，选择目录的所有者。

      默认情况下，您是所有者。 不过，您也可以指定作为提供商组织成员的任何用户。

   3. 继续执行步骤 3 以配置目录。

   使用激活链接向预期目录所有者发送邀请电子邮件:

   1. 单击添加 > 邀请目录所有者。
   2. 输入目录所有者的电子邮件地址，然后单击邀请。
   3. 收到电子邮件时，目录所有者必须激活目录并对其进行配置:
      1. 打开激活链接，填写注册表单，然后登录 API 管理器用户界面。
      2. 单击 " 管理目录" ，单击注册表单中提供的目录名称，然后单击 " 目录设置 "选项卡。
      3. 继续执行步骤 6 以配置目录。
3. 输入目录 标题。 名称将自动输入且无法进行更改。
   注: 名称 字段中的值是用于在 developer toolkit CLI 命令中标识目录的单个字符串。 标题 用于显示; 您可以更改标题，但名称不会更改。

   要查看管理目录的 CLI 命令，请参阅工具包 CLI 参考文档。

4. 单击 创建。
   该新目录将显示在“管理”页面上。
5. 要继续配置目录，请在 " 管理 " 页面上选择目录，然后单击 目录设置 选项卡。
6. 要配置目录的常规设置，请单击概览 ，然后继续以下步骤。
   1. 要在生产中使用目录，请将 " 生产模式 "滑块控制设置到 " 开 " 位置，然后单击 " 确认 "。

      缺省情况下，新目录是开发目录。

      在开发目录中，将强制执行所有发布操作，并且自动解决任何冲突。 如果重新发布以前发布的产品版本，那么将进行覆盖而不发出警告，例如，允许您在测试期间反复重新发布相同的产品版本。 如果在开发目录中启用了空间，并且将先前已发布的产品版本重新发布到其他空间，那么将从先前空间中移除此产品。

      但是，如果已将目录配置为需要审批，则开发目录在暂存和发布操作需要审批方面的行为与其他目录相同。

      注: 在生产目录中，以下条件适用:

      • 如果目录中已有名称和版本相同的产品，那么无法将产品发布到目录。 而是必须创建产品的新版本以进行发布; 请参阅 创建产品的新版本 。 如果在生产目录中启用空间，那么无法将具有相同名称和版本的产品发布到目录中的多个空间。
      • 如果新产品包含一个或多个修改过的 API，则必须创建新版本的 API 以纳入产品；请参阅创建新版本的 API 定义。 如果产品包含修改过的 API，且已发布的 API 具有相同的名称和版本，则不会发布更改。
   2. 要在空间中启用此目录的分区，请将 空间 滑块控件设置为 开启 位置，然后单击 确认。
      有关详细信息，请参阅 在 IBM API Connect 中使用聚合。
   3. 如果目录是缺省登台目录，请将 缺省 滑块控件移至 开启 位置，然后单击 确认。 然后，对发布到目录的 API 的调用可以使用不包括目录名称的简短 URL。
      注: 只能对一个目录启用 缺省值 。 如果另一个目录已被设置为默认目录，则在未禁用另一个目录上的设置之前，无法在此 目录上启用该设置。
   4. 要对在与此目录关联的 Developer Portal 中创建的应用程序启用应用程序生命周期，请将 应用程序生命周期 设置为 On，然后单击 确认。
      启用应用程序生命周期后，缺省情况下，应用程序开发者在 开发者门户网站 中创建的任何应用程序都具有 "开发" 状态。 应用程序测试完成后，应用程序开发者可以请求将应用程序升级到生产状态。 更多信息，请参阅管理应用程序生命周期。
7. 要配置目录的网关服务设置，请单击网关服务 ，然后继续以下步骤。
   注意： 如果在目录中启用了空间，则是为空间而不是为整个目录配置网关设置。
   1. 单击 编辑。
   2. 选择要用于此目录的网关服务。
      Cloud Manager UI 配置网关服务。 更多信息，请参阅注册网关服务。 如果已配置目录默认网关服务，则会在创建新目录时选择这些服务；请参阅为目录配置默认 网关服务。

      TYPE 列指示列出的每个网关服务， DataPower® Gateway (v5 compatible)， DataPower API Gateway或事件网关服务的网关类型。 有关更多信息，请参阅 API Connect 网关类型。

   3. 单击保存以保存更改。
      对于没有提供事件网关服务的目录，从 Event Endpoint Management 创建或导入 AsynchAPIs 的用户界面被禁用。 如果要在目录中使用 AsynchAPIs ，必须在目录中添加事件网关服务。

   通过将 API 添加到产品中，然后将该产品发布到目录，就可以发布这些 API。 要在目录中发布产品，目录必须至少分配给一个网关服务，这样产品中的 API 才能在网关服务端点调用。 您可以将多个网关服务分配给一个目录，它们可以是混合类型 DataPower API Gateway 和 DataPower Gateway (v5 compatible)。

   产品是特定于网关类型的 DataPower API Gateway 或 DataPower Gateway (v5 compatible)。 缺省情况下，将产品发布到目录时，会将其发布到与该产品类型相同的所有已分配网关服务，但您可以选择在发布时仅将该产品发布到该类型的所选网关服务; 请参阅 发布草稿产品 以获取更多信息。 产品中的 API 可在所有指定的网关服务端点调用。

   如果选择了两个或更多网关服务，那么要在开发者门户中提供该目录的分析数据，网关服务必须都与同一个分析服务相关联。 如果所选网关服务的关联分析服务集包括两个或多个不同的分析服务，则开发人员门户不会显示分析数据。 分析服务与 Cloud Manager 用户界面中的网关服务相关联；请参阅将分析服务与网关服务相关联。

   注： 还可以使用开发者工具包 CLI 配置目录的网关服务设置；有关详情，请参阅工具包 CLI 参考文档。
8. 要指定希望实施核准的产品生命周期状态更改，请完成以下步骤：
   1. 单击目录设置导航窗格中的生命周期审批 ，然后单击编辑。
   2. 选择所需的状态更改，然后在完成时单击 保存 。
      例如，如果您选择 " 发布 " 并清除其他复选框，则任何人尝试发布产品时都需要审批，但其他生命周期状态更改则不需要审批。

      注: 缺省情况下，已禁用对目录中产品生命周期状态更改的核准。 您必须显式启用要实施的产品生命周期状态更改。
   3. 要允许产品生命周期变更的发起人自行批准，请将任务自行批准滑块控制移动到开的位置，然后单击确认。
      注: 在开发目录中，产品生命周期变更的发起方始终可以自行核准该变更。 在生产目录中，产品生命周期变更的发起人只有在启用了目录设置 " 任务自批准 "的情况下，才能自行批准变更。
   4. 单击保存。
9. 要配置 API 管理器中每个角色的权限，请完成以下步骤。
   1. 单击目录设置导航窗格中的 角色 。
      要查看角色的当前许可权，请展开该角色。
   2. 单击要处理的角色旁边的选项图标 ，然后单击编辑。
   3. 根据需要选中或清除许可权复选框。

      要确保角色可以管理用户定义的策略 ，请为设置权限选择 " 管理"。

      要为角色授予用于核准特定生命周期状态更改的许可权，请在产品核准部分中选择状态更改。

      注: 您无法除去已在提供者组织级别分配给角色的许可权。 但是，您可以在提供者组织级别添加尚未分配的许可权。
   4. 要将角色映射到组，请在 “外部角色映射” 下，选中 “启用外部组映射” 复选框，然后在每个字段中输入所需信息。
   5. 单击保存。
10. 要管理 API 使用者在此目录中的加载，请完成以下步骤:
    1. 单击目录设置导航窗格中的 加载 。
    2. 要选择用于认证与此目录关联的 Developer Portal 用户的注册表，请单击 目录用户注册表 部分中的 编辑 ，选择所需的注册表，然后单击 保存。
       有关如何配置用户注册表的更多信息，请参阅使用企业用户注册表进行身份验证。

       重要： 当启用自助入职服务或预计在任何站点删除帐户时，请勿在 API 管理器和开发人员门户网站之间或开发人员门户网站站点之间共享用户注册表。 您应该为它们创建单独的用户注册表，即使单独的注册表指向相同的后端认证提供程序 (例如， LDAP 服务器) 也是如此。 这种分离使开发人员门户能够在整个目录中维护唯一的电子邮件地址，而无需 API 管理器满足同样的要求。 这也避免了用户从开发人员门户网站删除账户后影响其 API 管理器访问的问题。
    3. 要设置默认注册表，请找到所需的注册表，然后单击 设置默认值。

       当 API 用户注册开发者门户网站时，默认使用指定的注册表，也可以选择其他注册表。

    4. 要允许 API 用户自行完成开发人员门户的注册流程，请将自助服务入门设置为开。
       如果禁用此选项，API 消费者就不能在没有消费者组织所有者邀请的情况下注册。
    5. 要要求所有新的自助服务入驻开发人员门户都需要审批，请将自助服务入驻审批设置为开。
       如果启用此选项，API 消费者在尝试注册开发者门户网站时，都会发送批准请求。 该请求将显示在相关开发人员门户目录的任务选项卡中，可从该选项卡中批准或拒绝该请求。

       只要创建了消费者组织，就会执行自助服务入职审批。 因此，即使 API 消费者已获准通过特定消费者组织访问开发者门户 ，如果他们试图在同一开发者门户中创建另一个消费者组织，其请求仍将通过审批流程。

       注: 要启用自助服务入职核准，还必须完成以下任务:

       • 配置用户注册表以需要用户的电子邮件地址。
       • 配置 OIDC 应用程序以发送用户的电子邮件地址进行核准。
    6. 要编辑自助服务入职任务的超时时间段，请单击 自助服务入职任务超时 部分中的 编辑 ，指定所需的超时时间段，然后单击 保存。 此任务的超时周期涵盖电子邮件激活链接，如果启用了 自助服务入职审批 ，那么将涵盖审批流程。 自助服务加载任务的缺省超时周期为 72 小时。
       过期的自助服务入职任务每天只能在开发人员门户网站上清除一次。 因此，任何有过期注册任务的 API 消费者必须等到这些任务被清除后才能再次尝试注册。
    7. 要配置 API 使用者邀请合作者并将其分配给角色的能力，请单击 使用者邀请和角色 部分中的 编辑 ，选择所需的选项，然后单击 保存。
    8. 要配置在向应用程序开发者发送的电子邮件邀请中发送的激活链接的超时，请单击 邀请超时 部分中的 编辑 ，指定超时长度，然后单击 保存。 邀请链接的缺省超时周期为 48 小时。
    9. 要覆盖使用者组织邀请设置的超时，请将 使用目录邀请超时覆盖使用者组织的邀请超时 设置为 开启。

       目录自身的超时设置将被使用。

    注意： 上架目录设置同时适用于消费者目录和开发者门户。
11. 要指定用于保护此目录中的 API 访问的用户注册表，以及向沙箱目录添加用户注册表，请完成以下步骤：
    1. 单击 目录设置选项卡 ，然后选择 API 用户注册。
    2. 单击 编辑 ，然后选择要使用的用户注册表。
       有关如何配置用户注册表的更多信息，请参阅使用企业用户注册表进行身份验证。
    3. 完成后单击 保存 。
    注：

    • 只有 LDAP 和 Authentication URL 注册才能用于确保 API 的访问安全。 因此，只有这些类型的登记册才会被列出并可供挑选。
    • 如果目录中启用了空格，则应指定空格的用户注册，而不是整个目录的用户注册。 如果在目录中的一个空间中指定用户注册表，那么会将其部署到该目录中的所有空间中的网关服务。

      有关启用和管理空间的更多信息，请参阅 在 API Connect中使用联合

      .
12. 要指定可用于确保对本目录中 API 的访问安全的 OAuth 提供程序，请完成以下步骤。
    注：

    • 如果要为目录指定 OAuth 提供者，请确保已将沙箱目录配置为使用相同的 OAuth 提供者
    • 您还必须在目录中启用 OAuth 提供者引用的任何资源（例如 API 用户注册表或 TLS 客户机概要文件）
    • 如果在目录中启用了空间，则应为空间指定 OAuth 提供者， 而不是为整个目录指定 OAuth 提供者。 如果在目录中的一个空间中指定 OAuth 提供者，那么会将其部署到该目录中所有空间中的网关服务。

      有关启用和管理空间的更多信息，请参阅 在 API Connect中使用联合。

    1. 单击目录设置导航窗格中的 OAuth 提供商。
    2. 单击 编辑，然后选择要使用的 OAuth 提供者。

       要配置 OAuth 提供程序，请参阅“使用 Cloud Manager 配置原生 OAuth 提供程序” 或“使用 API Manager 配置原生 OAuth 提供程序”。

    3. 完成后单击 保存 。
13. 要配置用于此目录的 TLS 客户机概要文件，请完成以下步骤：
    注意： 如果在目录中启用了空间，则要为空间而不是整个目录配置 TLS 客户端配置文件。 如果在目录中的一个空间内配置 TLS 客户机概要文件，那么会将其部署到该目录中所有空间内的网关服务。

    有关启用和管理空间的更多信息，请参阅 在 API Connect中使用联合。

    1. 单击目录设置导航窗格中的 TLS 客户端配置文件。
    2. 单击 编辑，然后选择要用于此目录的 TLS 客户机概要文件。
       有关如何创建 TLS 客户端配置文件的更多信息，请参阅创建 TLS 客户端配置文件。
    3. 完成后单击 保存 。
14. 您有两个用于与应用程序开发者共享 API 的选项。 使用缺省 使用者目录 来实现轻量级使用者体验; 无定制，基本功能，非常适合小型 API 目录和内部用户。 您不需要 Portal 服务来配置 使用者目录。 有关在开发人员门户和消费者目录之间进行选择的更多详情，请参阅消费者目录和开发人员门户注意事项。
    要启用 使用者目录，请完成以下步骤:
    1. 单击目录设置导航窗格中的 门户网站 ，然后将 使用者目录 设置为 开启。 显示 《消费者目录 》 URL。
       缺省情况下， 使用者目录 设置为 On。
    2. 点击 URL 访问消费者目录。
    如果您需要目录的完整内容管理系统，请创建 开发者门户网站; 完全可定制的完整功能，并且是大型 API 目录和业务用户的理想之选。 您需要 Portal 服务来配置 Developer Portal。 要配置 Developer Portal，请完成以下步骤:
    1. 单击目录设置导航窗格中的 门户网站 ，然后单击 创建。
    2. 选择要用于此目录的门户网站服务。
       门户网站服务是使用 Cloud Manager UI 配置的。 有关详细信息，请参阅 注册门户网站服务。
    3. （可选）覆盖生成的缺省门户网站 URL。
       此 URL 必须采用以下格式：

       https://host_name.portal.com

       其中 host_name.portal.com 必须解析为 Developer Portal 机器的 IP 地址。

       例如：

       https://myhost.mydomain.com

       重要说明：

       • 在所有目录中，URL 必须唯一。
       • 资源名称支持混合大小写名称; 但是，门户网站端点 URL 只能支持小写。 如果供应商组织名称为大小写混合，则必须编辑默认生成的门户 URL ，使供应商组织名称在 URL 中为小写。

       要在您的网站中使用子路径 URL ，请参阅 开发者门户网站的子路径。
    4. 单击 创建 以保存更改。
       有关使用 开发者门户网站的更多信息，请参阅 开发者门户网站: 社交化 API。
    如果您想编辑门户网站服务或 URL ，请返回此门户网站设置页面并点击 “编辑 ”。 要删除门户网站，单击选项图标 ，然后单击删除。
    注: 目录所有者的帐户概要文件必须具有指定的电子邮件地址才能接收创建通知，否则 Developer Portal 创建操作将失败。 要检查帐户概要文件是否包含电子邮件地址并指定值，请完成以下步骤：

    1. 单击用户图标 ，然后选择我的帐户。
    2. 检查电子邮件字段的内容并根据需要指定值，然后单击保存。
15. 要定义目录属性，请完成以下步骤：
    1. 单击目录设置导航窗格中的目录属性 ，然后单击创建。
    2. 输入属性名称和值。
    3. 选择受保护复选框以编辑属性。
       注： 属性创建为受保护属性后，将保持编辑状态，其值显示为 ******。 如果想让该值可见，请删除该属性，然后在不选择 " 受保护 "选项的情况下重新创建。
    4. 单击 创建。
    可以在此目录中的任何 API 定义中引用您定义的属性。 还可以定义特定于 API 定义的属性; 请参阅 设置 API 属性。 有关如何在 API 定义中引用属性的信息，请参阅 API Connect 中的变量引用。

    注：

    • 如果您定义了与 API 属性同名的目录属性，那么 API 属性优先于目录属性。
    • 如果更改目录属性的值，那么必须重新发布引用该属性的任何 API，才能使用新值。
16. 可选： 要配置发布到目录或空间的产品的可见性，请参阅在目录或空间级别配置产品可见性。