安装工具箱

您可以为 IBM® API Connect安装提供 CLI 命令的工具箱和 API Designer 用户界面。

要安装和运行工具箱，请完成以下步骤：

1. 下载工具箱压缩文件。
   • 要从 IBM Fix Central下载 Toolkit ，请完成以下步骤:
     1. 在浏览器中打开 IBM Fix Central 站点 。
     2. 在产品选择器字段中，输入 API Connect，然后从下拉列表中选择 IBM API Connect。
     3. 选择 已安装版本 ，然后单击 继续。 如果您不知道已安装的 IBM API Connect 版本，请与管理员联系。
     4. 在 文本 字段中，输入 toolkit，然后单击 继续。
     5. 选择要下载的工具箱文件。
     6. 单击继续，然后遵循指示信息来完成下载操作。
   • 要从 Cloud Manager 或 API Manager 用户界面下载 Toolkit ，请完成以下步骤:
     1. 打开 Cloud Manager 或 API Manager 用户界面。
     2. 在欢迎页面，单击 "下载客户端"磁贴。 这两个工具包选项列在工具包选项卡下。
     3. 根据需要单击 CLI 选项或 CLI + Designer 选项旁边的平台，然后将关联的压缩文件保存到本地文件系统。
     4. 要下载 API Designer 凭证 (客户机标识和客户机密钥) ，请单击 API Designer 凭证旁边的 下载 ，然后将 designer_credentials.json 文件保存到本地文件系统。 提供了用于安装凭证的命令，如步骤 5中所述。
     5. 要下载工具箱凭证（客户机标识和客户机密钥），请单击凭证旁边的下载，然后将 credentials.json 文件保存到本地文件系统上。 提供了用于安装凭证的命令，如步骤 4中所述。
2. 将工具箱压缩文件的内容解压缩到所选的文件夹中。

   此文件的内容取决于所选的工具箱选项和平台，如下所示：

   • apic-slim 或 apic-slim.exe 文件是 IBM API Connect的 CLI。
   • apic 或 apic.exe 文件是 IBM API Connect的 CLI。
     提示: 如果您正在使用 CLI 选项，那么如果将 apic-slim 文件重命名为 apic，或者将 apic-slim.exe 文件重命名为 apic.exe，那么可以运行与文档中记录的完全相同的 CLI 命令，复制并粘贴样本命令，并按原样使用任何命令脚本 (如果稍后移至 CLI + Designer 选项)。
   • api_designer-platform 文件是用于所指定平台的 API Designer 用户界面应用程序。
3. 运行 CLI。
   • 对于 macOS 或 Linux® 平台，请完成以下步骤：
     1. 打开终端实例，并浏览至已将工具箱压缩文件内容解压缩到的文件夹。
     2. 输入以下命令使 CLI 文件成为可执行文件：

        chmod +x download_name

        其中 download_name 是下载的工具箱文件的名称（apic 或 apic-slim）。
     3. 若您正在使用 macOS 该功能，请执行以下命令移除隔离属性：

        sudo xattr -dr com.apple.quarantine apic-slim
        

     4. 按如下方式运行 CLI 命令：

        ./apic command_name_and_parameters

        或

        ./apic-slim command_name_and_parameters

        有关 CLI 命令的详细信息，请参阅工具包 CLI 参考文档。
   • 对于 Windows 平台，请完成以下步骤：
     1. 打开命令提示符并浏览到解压缩工具箱压缩文件内容的文件夹。
     2. 按如下方式运行 CLI 命令：

        apic command_name_and_parameters

        或

        apic-slim command_name_and_parameters

        有关 CLI 命令的详细信息，请参阅工具包 CLI 参考文档。

   提示: 将 CLI 文件的文件夹位置添加到 PATH 变量，以便可以从文件系统中的任何位置运行 CLI 命令。
4. 安装工具箱凭证。
   如果未安装提供供下载的工具箱凭证 (如先前在 工具箱凭证下载指示信息中所详述) ，那么 API Connect 将使用与所有部署相同的一组缺省凭证。 但是，下载的凭证是在 API Connect 系统部署期间生成的，并且是您的安装所独有的凭证。 要将凭证安装到本地工具箱，请运行以下命令：

   apic client-creds:set toolkit_credentials_file_path/credentials.json

   其中，credentials_file_path 是用于放置所下载的工具箱凭证 JSON 文件的位置。 运行此命令后，工具箱将使用这些新凭证向管理服务器进行认证。

   注: 在任何时候，都只能使用一组工具箱凭证从工具箱 CLI 登录到管理服务器。 如果要登录另一管理服务器，必须从该管理服务器安装工具箱凭证。

   要从工具箱 CLI 还原为所有登录操作的缺省工具箱凭证，请使用以下命令:

   apic client-creds:clear

   为了提高安全性，管理员可以通过完成以下步骤从管理服务器中除去缺省凭证:

   1. 以管理员身份登录管理服务器；请参阅登录管理服务器。
   2. 通过运行以下命令来删除缺省凭证:

      apic registrations:delete toolkit --server mgmt_endpoint_url
      apic registrations:delete consumer-toolkit --server mgmt_endpoint_url

5. 安装 API Designer 凭证。

   如果未安装提供供下载的 API Designer 凭证 (如先前在 API Designer 凭证下载指示信息中所详述) ，那么 API Connect 将对所有部署使用一组相同的缺省凭证。 但是，下载的凭证是在 API Connect 系统部署期间生成的，并且是您的安装所独有的凭证。 要将定制凭证安装到本地 API Designer中，请使用适用于您操作系统的机制将 APIC_DESIGNER_CREDENTIALS 环境变量设置为凭证下载位置。

   设置 APIC_DESIGNER_CREDENTIALS 环境变量后， API Designer 将使用新凭证向管理服务器进行认证。

   • Windows：

     如果您正在使用 Windows ，请使用下列其中一种方法创建环境变量:

     • 创建永久环境变量，以便可以从计算机上的任何位置启动 API Designer:
       1. 打开 "环境变量 "页面：单击 "开始 > 设置 > 系统，然后在页面的 "相关设置 "部分单击 "高级系统设置。
       2. 在 "系统属性" 对话框的 "高级" 选项卡上，单击 环境变量。
       3. 在 "用户变量" 部分中，单击 新建 并使用以下设置创建环境变量:
          • 变量： APIC_DESIGNER_CREDENTIALS
          • 值: <designer_credentials_file_path>\designer_credentials.json ，其中 <designer_credentials_file_path> 是存储 designer_credentials.json 文件的位置。
       4. 单击 确定 以保存新环境变量，然后退出对话框。
     • 如果您没有创建永久环境变量所需的许可权，那么可以创建仅在运行 API Designer 应用程序时使用的临时环境变量。 每次启动 API Designer 时，都必须执行以下步骤:
       1. 打开 Windows 命令提示符。
       2. 运行以下命令以设置临时环境变量:

          set APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>\designer_credentials.json

          其中， <designer_credentials_file_path> 是存储 designer_credentials.json 文件的位置。

          注: 使命令提示符保持打开状态以执行下一步。 必须在同一 Windows 命令会话中设置临时变量并启动 API Designer。
       3. 现在运行以下命令以启动 API Designer:

          C:\"Program Files\API Designer\API Designer.exe"

          缺省情况下， API Designer 安装在 C:\"Program Files\API Designer 文件夹中，如示例中所示。 如果将其安装到其他位置，请在命令中使用您自己的位置。 请注意，路径和文件名将括在引号中，因为它们包含空格。

   • Mac：

     若您正在使用 macOS ，请通过以下任一方法创建环境变量：

     • 运行以下命令以设置全局环境变量:

       launchctl setenv APIC_DESIGNER_CREDENTIALS <designer_credentials_file_path>/designer_credentials.json

       其中， <designer_credentials_file_path> 是存储 API Designer 凭证 JSON 文件的位置。
     • 从命令行启动 API Designer 时传入环境变量。 使用此方法时，每次启动 API Designer 时都必须运行以下命令:

       APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>/designer_credentials.json open <designer_application_file_path>/'API Designer.app'

       其中：
       • <designer_credentials_file_path> 是将 API Designer 凭证 JSON 文件下载到的位置。
       • <designer_application_file_path> 是您下载并解压缩 API Designer 应用程序的位置。
6. 从存储所抽取文件的位置启动 API Designer 应用程序。
   注：

   • 要在具有非管理员帐户的 Windows 平台上卸载 API Designer 应用程序，请完成以下步骤:
     1. 在 Windows 文件资源管理器中，浏览至 USER_HOME\AppData\Local\Programs\api-designer 文件夹。
     2. 运行 Uninstall API Designer application 应用程序。 请勿 使用 Add or remove programs 窗口。
   • 要在具有管理员帐户的 Windows 平台上卸载 API Designer 应用程序，您可以运行 Uninstall API Designer application 应用程序，也可以使用 Add or remove programs 窗口。