创建和配置目录

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

准备工作

您必须拥有目录创建权限才能完成此任务。
  • 作为创建目录的用户，您自动成为目录所有者并具有所有目录许可权。
  • 如果配置了新的用户注册表，用于验证开发人员门户的用户身份，则还必须完成目录中的入职部分，以便向开发人员门户用户提供注册表。 详见步骤10。
  • Developer Portal中的每个帐户 (包括同一站点的不同用户注册表) 都必须具有唯一的电子邮件地址，包括站点管理员帐户。 例如，如果为特定 Developer Portal 站点配置三个不同的用户注册表，那么只能使用电子邮件地址 alice@acme.com 从其中一个用户注册表登录到该站点。 管理员帐户的缺省电子邮件地址是目录所有者的电子邮件地址。 无法创建与管理员帐户（或与其电子邮件地址不同的目录所有者帐户）具有相同电子邮件地址的用户帐户（和关联的使用者组织）。 使用同一电子邮件地址创建帐户的所有尝试都将导致新帐户无法正常运行，并在尝试登录时返回以下错误消息：A user already exists with this email address。

过程

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

  1. 登录 "应用程序接口管理器，然后点击 "“管理”图标"管理。
  2. 创建目录。
    指定所有者，然后配置目录：
    1. 单击添加 > 创建目录。
    2. 在目录所有者字段中，选择目录的所有者；缺省情况下，您是所有者。 您可以指定属于提供者组织成员的任何用户。
    3. 从步骤3开始配置目录。
    1. 单击添加 > 邀请目录所有者。
    2. 输入目录所有者的电子邮件地址，然后单击邀请。
    3. 收到电子邮件后，目录所有者必须激活目录并进行配置：
      1. 打开激活链接，填写注册表单，然后登录API 管理员用户界面。
      2. 单击管理目录，单击注册表单上提供的目录名称，然后单击目录设置选项卡。
      3. 从步骤6开始配置目录。
  3. 输入目录标题。 名称将自动输入且无法进行更改。
    注意： "名称"字段中的值是一个字符串，用于在开发者工具包CLI 命令中标识目录。 标题 用于显示; 您可以更改标题，但名称不会更改。

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

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

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

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

      注：在生产目录中，以下条件适用：
      • 如果目录中已有相同名称和版本的产品，则不能将产品发布到目录中。 相反，您必须创建一个新的产品版本用于发布；请参阅创建新的产品版本 。 如果在生产目录中启用空间，那么无法将具有相同名称和版本的产品发布到目录中的多个空间。
      • 如果新产品包含一个或多个修改过的 API，则必须创建新版本的 API 以纳入产品；请参阅创建新版本的 API 定义。 如果产品包含已修改的 API，并且已存在相同名称和版本的已发布 API，那么不会发布更改。
    2. 要启用将此目录分割为空间，请将空间滑块控制设置到开位置，然后单击确认。
      有关详细信息，请参阅在IBM'API Connect中使用联合。
    3. 如果目录是默认的暂存目录，将 "默认值滑块控制移动到 "关于位置，然后单击 "确认。 然后，对发布到目录的 API 的调用可以使用不包括目录名称的简短 URL。
      注意：只能为一个目录启用默认值。 如果另一个目录已被设置为默认目录，那么如果不先禁用另一个目录上的设置，就无 法启用此目录上的设置。
  7. 要配置目录的网关服务设置，请单击网关服务，然后执行以下步骤：
    注意：如果在目录中启用了空间，则您要为空间而不是整个目录配置网关设置。
    1. 单击 编辑。
    2. 选择要用于此目录的网关服务。
    3. 单击保存以保存更改。
      对于没有提供事件网关服务的目录，从 Event Endpoint Management 创建或导入 AsynchAPIs 的用户界面被禁用。 如果要在目录中使用 AsynchAPIs ，必须在目录中添加事件网关服务。

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

    产品是网关的特定类型，即 "DataPower API Gateway或 "DataPower Gateway (v5 compatible)。 默认情况下，将产品发布到目录时，产品会发布到与产品属于同一网关类型的所有已分配网关服务，但您可以选择在发布时只将产品发布到该类型的选定网关服务；有关详细信息，请参阅发布产品草稿 。 产品中的 API 将可在所有指定的网关服务端点调用。

    如果选择了两个或更多网关服务，那么要在开发人员门户中提供该目录的分析数据，网关服务必须都与同一个分析服务相关联。 如果所选网关服务的关联分析服务集包含两个或多个不同的分析服务，那么 Developer Portal 不会 显示分析数据。
    注：还可以使用开发者工具包CLI 配置目录的网关服务设置；有关详情，请参阅工具包 CLI 参考文档。
  8. 要指定希望实施核准的产品生命周期状态更改，请完成以下步骤：
    1. 单击目录设置导航窗格中的生命周期审批，然后单击编辑。
    2. 选择所需的状态更改，然后在完成时单击 保存 。
      例如，如果取消选中所有其他复选框而只选择了“发布”，那么在任何人尝试发布某个产品时都需要进行核准，但任何其他生命周期状态更改都不需要进行核准。
      请注意： 目录中产品生命周期状态更改的审批默认为禁用。 您必须显式启用要实施的产品生命周期状态更改。
    3. 要允许产品生命周期变更的发起人自行批准，请将任务自行批准滑块控制移动到开的位置。
      注意：在开发目录中，产品生命周期变更的发起人总是可以自己批准变更。 在生产目录中，产品生命周期变更的发起人只有在目录设置 "任务自行批准 "启用的情况下才能自行批准变更。
    4. 完成后单击 保存 。
  9. 要配置 API Manager 中每个角色具有的许可权，请完成以下步骤:
    1. 单击目录设置导航窗格中的角色。
      要查看角色的当前许可权，请展开该角色。
    2. 单击要处理的角色旁边的选项图标 "“选项”图标，然后单击 "编辑"。
    3. 根据需要选中或清除许可权复选框。

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

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

      注: 您无法除去已在提供者组织级别分配给角色的许可权。 但是，您可以在提供者组织级别添加尚未分配的许可权。
    4. 完成后单击 保存 。
  10. 要管理 API 消费者加入此目录，请完成以下步骤：
    1. 单击目录设置导航窗格中的上机。
    2. 要选择用于验证与此目录相关的开发人员门户用户身份的注册表，请单击 "目录用户注册表" 部分中的 "编辑"，选择所需的注册表，然后单击 "保存"。
      有关如何配置用户注册表的详细信息，请参阅使用企业用户注册表进行身份验证。
      重要信息: 请勿在 API Manager 与 Developer Portal之间或 Developer Portal 站点之间共享用户注册表 (如果启用了自助服务加载或期望在任何站点中删除帐户)。 您应该为它们创建单独的用户注册表，即使单独的注册表指向相同的后端认证提供程序 (例如， LDAP 服务器) 也是如此。 这种分离使开发人员门户能够在整个目录中维护唯一的电子邮件地址，而无需API 管理器满足同样的要求。 这还可避免用户从 Developer Portal 中删除其帐户时发生问题，从而影响其 API Manager 访问权。
    3. 要设置默认注册表，请找到所需的注册表，然后单击 "“选项”图标 设置默认值。

      当 API 使用者注册到 开发者门户网站时，缺省情况下将使用指定的注册表以及用于选择另一个注册表的选项。

    4. 要允许 API 用户自行完成开发人员门户的注册流程，请将自助服务入门设置为开。
      如果此选项处于禁用状态，那么如果没有使用者组织所有者的邀请，那么 API 使用者无法注册。
    5. 要要求开发人员门户的所有新自助服务入职都需要批准，请将自助服务入职批准设置为开。
      如果启用了此选项，那么 API 使用者尝试注册到 Developer Portal 将导致发送核准请求。 该请求会显示在相关开发人员门户目录的任务选项卡中，可从该选项卡中批准或拒绝该请求。

      请注意，每当创建使用者组织时，都会采用 自助服务上线核准 。 因此，即使已批准 API 使用者访问具有特定使用者组织的 开发者门户网站 ，如果他们随后尝试在同一 开发者门户网站中创建另一个使用者组织，他们的请求仍将经历核准过程。

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

      将改为使用目录自己的超时设置。

    注意：上架目录设置同时适用于消费者目录和开发者门户。
  11. 要指定用于保护此目录中的 API 访问的用户注册表，以及向沙箱目录添加用户注册表，请完成以下步骤：
    1. 单击 目录设置 选项卡，然后选择 API 用户注册表。
    2. 单击 编辑 ，然后选择要使用的用户注册表。
      有关如何配置用户注册表的详细信息，请参阅使用企业用户注册表进行身份验证。
    3. 完成后单击 保存 。
    注：
    • 只有 LDAP 和认证 URL 注册表可用于保护 API 访问；因此，仅列示和可选择这些类型的注册表，
    • 如果在目录中启用了空格，则应指定空格的用户注册，而不是整个目录的用户注册。 如果在目录中的一个空间指定了用户注册，则会将其部署到该目录中所有空间的网关服务中。

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

      .
  12. 要指定可用于确保对本目录中 API 的访问安全的OAuth 提供程序，请完成以下步骤：
    注：
    • 如果要为目录指定 OAuth 提供者，请确保已将沙箱目录配置为使用相同的 OAuth 提供者
    • 您还必须在目录中启用 OAuth 提供者引用的任何资源（例如 API 用户注册表或 TLS 客户机概要文件）
    • 如果在目录中启用了空间，则应为空间指定 OAuth 提供商，而不是为整个目录指定 OAuth 提供商。 如果在目录中的一个空间指定了 OAuth 提供程序，则该提供程序会部署到目录中所有空间的网关服务中。

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

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

      要配置 OAuth 提供程序，请参阅配置本地 OAuth 提供程序。

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

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

    1. 单击目录设置导航窗格中的TLS 客户端配置文件。
    2. 单击编辑，然后选择要与此目录一起使用的 TLS 客户端配置文件。
      有关如何创建 TLS 客户端配置文件的详细信息，请参阅创建 TLS 客户端配置文件。
    3. 完成后单击 保存 。
  14. 您有两种与应用程序开发人员共享应用程序接口的选择。 使用默认消费者目录可获得轻量级消费者体验；无需定制，具有基本功能，是小型 API 目录和内部用户的理想选择。 配置消费者目录不需要门户服务。 有关在 "开发人员门户 "和"消费者目录"之间做出选择的详细信息，请参阅 "消费者目录 "和 "开发人员门户 "注意事项。
    要启用消费者目录，请完成以下步骤：
    1. 单击目录设置导航窗格中的 "门户"，然后将 "消费者目录 "设置为"开"。 显示 《消费者目录 》 URL。
      默认情况下，消费者目录设置为开。
    2. 点击 URL 访问消费者目录。
    如果您需要一个完整的目录内容管理系统，请创建一个 "开发人员门户网站；可完全定制，功能齐全，是大型 API 目录和企业用户的理想选择。 您需要一个门户服务来配置开发人员门户。 要配置开发人员门户，请完成以下步骤：
    1. 单击目录设置导航窗格中的门户，然后单击创建。
    2. 选择要用于此目录的门户网站服务。
    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 ，请返回此门户网站设置页面并点击 “编辑 ”。 要删除门户网站，请单击选项图标 "“选项”图标，然后单击 "删除"。
    注意：目录所有者的账户配置文件中必须指定接收创建通知的电子邮件地址，否则开发人员门户创建操作将失败。 要检查帐户概要文件是否包含电子邮件地址并指定值，请完成以下步骤：
    1. 点击用户图标 ""用户" 图标，然后选择我的账户。
    2. 检查电子邮件字段的内容并根据需要指定值，然后单击保存。
  15. 要定义目录属性，请完成以下步骤：
    1. 单击目录设置导航窗格中的属性，然后单击创建。
    2. 输入属性名称和值。
    3. 选择受保护复选框对属性进行加密。
      注意： 属性创建为受保护后，仍将保持加密状态。 如果想不加密，请删除该属性，然后在不选择受保护选项的情况下重新创建。
    4. 单击 创建。
    可以在此目录中的任何 API 定义中引用您定义的属性。 还可以定义特定于 API 定义的属性; 请参阅 设置 API 属性。 有关如何在 API 定义中引用属性的信息，请参阅 " API Connect中的变量引用。
    注：
    • 如果您定义了与 API 属性同名的目录属性，那么 API 属性优先于目录属性。
    • 如果更改目录属性的值，那么必须重新发布引用该属性的任何 API，才能使用新值。
  16. 可选： 要配置发布到目录或空间的产品的可见性，请参阅在目录或空间级别配置产品可见性。