API 开发和管理命令

在线编辑

IBM® API Connect 开发者工具箱中核心命令的摘要。

认证

使用 apic login 命令向 API Manager 服务进行认证，使用 apic logout 命令除去本地认证凭证。
注: 成功认证后，凭证将以纯文本形式存储在文件 [Icon indicating that this applies on Linux platforms].netrc 或 [Icon indicating that this applies on Windows platforms]_netrc中。 因此，您应该通过其他人不可访问您的凭证的方式设置文件许可权。

有关如何通过命令行界面 (CLI) 登录管理服务器的详细信息，请参阅 《 设置 API Connect 工具包 》中的“登录工具包”。

配置命令行工具以使用 TLS 证书

API Manager 使用 TLS 配置文件来保障数据传输的安全性。 有关如何在API Manager 中创建 TLS 配置文件的信息，请参阅 TLS profiles。

要配置工具包命令行工具，使其使用证书与启用了 TLS 配置文件的API Manager 进行通信，请执行以下步骤：

有关 NODE_EXTRA_CA_CERTS 环境变量的更多信息，请参阅 Node.js 文档。

创建和管理本地文件

在将 API 和产品定义 YAML 文件登台到 API Manager之前，可在本地创建并使用这些文件。

要创建本地 API 定义文件，请使用 apic create:api 命令。 要创建本地产品定义文件，请使用 apic create:product 命令。

使用 apic apis 和 apic products 命令可列出指定类型的 API Manager 工件。

要验证本地 API 或产品定义文件的语法是否正确，请使用 apic validate 命令。

要在 API Manager 中从本地 API 或产品定义文件创建草稿 API ，请分别使用 apic draft-apis:create 和 apic draft-products:create 命令。

注: 如果定义 API 的 OpenAPI 文件使用 $ref 字段来引用单独文件中定义的 OpenAPI 代码片段，那么在验证 API ，在草稿中创建 API ，登台 API 或发布 API 之前， $ref 字段将替换为目标文件的内容。 有关更多信息，请参阅 使用 $ref 在 OpenAPI 文件中复用代码片段。

支持通配符的 API 路径搜索

您可以使用 和 apis:list-all apis:list 命令中的新 full_path 查询参数，在发布到目录中的所有 API 的完整路径范围内进行灵活搜索。 该 full_path 参数允许您使用完整的 API 路径进行搜索，该路径包含基础路径和路径。 API 路径搜索功能的这一改进，使您在管理大量 API 时能够进行更强大、更灵活的搜索。 使用此功能，可根据已发布的完整路径快速定位 API，从而在大型环境中提高工作效率。

支持以下通配符：

  • *: 匹配零个或多个字符。

  • ?: 匹配任意单个字符。

例如，

您可以使用以下命令搜索路径完全匹配的 /test API：
apic apis:list-all -s <server> --scope catalog -o <org> -c <catalog> --full_path=/test
您可以使用以下命令搜索全路径以 开头的 API /test：
apic apis:list-all -s <server> --scope catalog -o <org> -c <catalog> --full_path=/test*

使用目录和 空间

要创建目录，请使用 apic catalog:create 命令。 要查看目录相关信息，请使用 apic catalog:get 命令；要列示当前已认证的用户所属的组织中所包含的所有目录，请使用 apic catalogs 命令。

您可以使用空间来对目录进行分区，以便多个团队可以在单个目录中独立管理各种产品和 API。 从概念上讲 ，“空间 ”类似于子目录，不同之处在于，目录内所有空间中的产品和 API 都会发布到同一个消费者目录中。 有关“空间 ”的更多信息，请参阅 《 IBM 中使用 API Connect聚合 》一文。

要对目录启用空间，请使用以下命令：
apic catalogs:set catalog_name --spaces enabled
使用工具箱 apic spaces 命令来创建和管理 空间:
  • apic spaces -列出目录中包含的 空间 。
  • apic:spaces create -在目录中创建 空间 。
  • apic:spaces get -获取有关目录中 空间 的信息。
  • apic:spaces set -设置有关目录中 空间 的信息。
  • apic:spaces delete -删除目录中的 空间 。

命令摘要

以下各表汇总了用于 API 开发和管理的 apic 命令。

表 1. 通用命令摘要
命令 描述 子命令
apic config 列示并管理配置变量。 有关更多信息，请参阅 使用配置变量。

如果不使用子命令，那么将列示定义的配置变量的值。
  • apic config － 管理配置变量
  • apic config:clear - 删除所有配置变量
  • apic config:delete － 删除配置变量
  • apic config:get － 获取配置变量
  • apic config:list － 列示应用程序和全局配置变量
  • apic config:set － 设置或更新配置变量
apic create 创建草稿 API 或产品定义 YAML 文件。
  • create:api - 创建草稿 API OpenAPI 定义 YAML 文件
  • create:product - 创建产品定义 YAML 文件
apic extensions 管理目录中的 OpenAPI 扩展。

如果不使用子命令，那么会列示生产目录中的扩展。
  • apic extensions － 扩展集合操作。
  • apic extensions:clear - 删除给定名称的扩展的所有版本。
  • apic extensions:clear-all - 删除所有扩展的所有版本。
  • apic extensions:clone - 将所有扩展的所有版本下载到本地驱动器。
  • apic extensions:create - 创建扩展。
  • apic extensions:delete - 按标识或按名称和版本删除扩展。
  • apic extensions:document - 按标识或按名称和版本获取扩展文档。
  • apic extensions:get - 按标识或按名称和版本获取扩展。
  • apic extensions:list - 列出给定名称的扩展的所有版本。
  • apic extensions:list-all - 列出所有扩展的所有版本。
  • apic extensions:update - 按标识或按名称和版本更新扩展。
apic login 登录 API Manager。 无。 使用所需标志指定服务器和凭证：
  • -p, --password 密码
  • -r, --realm realm。 确定用于认证提供的用户标识的身份提供者以及成功登录后可执行的任务范围。
  • -s, --server mgmt_endpoint_url。 针对此条目请使用平台 API 端点 URL 的值。
  • -u, --username 用户名

有关如何通过命令行界面 (CLI) 登录管理服务器的详细信息，请参阅 《 设置 API Connect 工具包 》中的“登录工具包”。
apic logout 从 API Manager 注销。 无。 使用所需标志指定服务器：
  • -s, --server mgmt_service。

如果端口号不是缺省值 443，那么可以将其附加到服务器名称。
apic validate 验证 API 或产品定义 YAML 文件。 无
表 2. 管理 API、产品和目录的命令摘要
命令 描述 子命令
apic apis 列示和管理已登台或已发布到目录或 空间的 API。

缺省子命令为 list-all。
  • apic apis - API 集合操作
  • apic apis:get - 按名称和版本或按标识获取 API 的 OpenAPI 定义 YAML 文件
  • apic apis:list - 按名称列示 API
  • apic apis:list-all - 列示目录或空间中的所有 API
  • apic apis:update - 按名称更新 API
apic apps 列示和管理在使用者组织中注册的开发者应用程序。

缺省子命令为 list。
  • apic apps - 应用程序集合操作
  • apic apps:clear - 清除所有应用程序
  • apic apps:create - 创建应用程序
  • apic apps:delete - 按名称或标识删除应用程序
  • apic apps:get - 按名称获取应用程序对象
  • apic apps:list - 列示使用者组织中的所有应用程序
  • apic apps:update - 按名称或标识更新应用程序
apic catalogs 列示和管理提供者组织中的目录。

缺省子命令为 list。
  • apic catalogs:clear - 清除提供者组织中的所有目录
  • apic catalogs:create - 创建目录
  • apic catalogs:delete - 按名称或标识删除目录
  • apic catalogs:get - 按名称或标识获取目录对象
  • apic catalogs:list - 列示提供者组织中的所有目录
  • apic catalogs:transfer-owner - 将目录的所有权移交给其他用户
  • apic catalogs:update - 按名称或标识更新目录
apic catalog-settings 管理目录的配置设置
  • apic catalog-settings:get - 获取目录设置。
  • apic catalog-settings:update - 更新目录设置。
apic drafts 列示和管理提供者组织中的草稿 API 和产品定义。

缺省子命令为 list。
  • apic drafts － 草稿集合操作
  • apic drafts:clear - 删除提供者组织中的所有草稿 API 和产品
  • apic drafts:list - 列示提供者组织中的草稿 API 和产品
apic draft-apis 列示和管理提供者组织中的草稿 API 定义。

缺省子命令为 list-all。
  • apic draft-apis － 草稿 API 集合操作
  • apic draft-apis:clear - 按名称删除草稿 API 的所有版本
  • apic draft-apis:clear-all - 删除提供者组织中的所有草稿 API
  • apic draft-apis:clone -克隆提供者组织中的所有草稿 API
  • apic draft-apis:create -创建草稿 API
  • apic draft-apis:delete - 按名称和版本删除草稿 API
  • apic draft-apis:document -按名称和版本获取草稿 API 文档
  • apic draft-apis:get - 按名称和版本获取 API 的 OpenAPI 定义 YAML 文件
  • apic draft-apis:list - 按名称列示草稿 API 的所有版本
  • apic draft-apis:list-all - 列示提供者组织中的所有草稿 API
  • apic draft-apis:update - 通过提供修改的 OpenAPI 定义文件，按名称和版本更新草稿 API
  • apic draft-apis:update-wsdl -按名称和版本更新草稿 SOAP API ，提供 .wsdl 或 .zip 格式的修订 WSDL 定义文件
    注: 现有 WSDL 中的服务名称必须与修订后的 WSDL 相匹配。 如果找到匹配项，那么 WSDL 服务将转换为用于更新 API 的 YAML 文件。 如果找不到匹配项，那么将显示错误消息。
  • apic draft-apis:validate - 验证草稿 API
  • apic draft-apis:wsdl -按名称和版本获取草稿 API WSDL 文档
apic draft-products 列示和管理提供者组织中的草稿产品定义。

缺省子命令为 list-all。
  • apic draft-products － 草稿产品集合操作
  • apic draft-products:clear - 按名称删除草稿产品的所有版本
  • apic draft-products:clear-all - 删除提供者组织中的所有草稿产品
  • apic draft-products:create - 创建草稿产品
  • apic draft-products:delete - 按名称和版本删除草稿产品
  • apic draft-products:get － 按名称和版本获取草稿产品
  • apic draft-products:list － 列示草稿产品
  • apic draft-products:list-all - 列示提供者组织中的所有草稿产品
  • apic draft-products:publish-all － 发布草稿产品
  • apic draft-products:update - 通过提供修改的定义文件，按名称和版本更新草稿产品
  • apic draft-products:validate - 验证草稿产品
apic members 列示和管理提供者组织、使用者组织、目录或空间的成员。

缺省子命令为 list。
  • apic members － 成员操作
  • apic members:clear - 删除所有成员
  • apic members:create － 创建成员
  • apic members:delete - 按名称或标识删除成员
  • apic members:get - 按名称或标识获取成员对象
  • apic members:list - 列示所有成员
  • apic members:update － 按名称或标识更新成员
apic member-invitations 列示和管理成员邀请。

在邀请用户成为提供者组织、使用者组织、目录或空间的成员时，创建成员邀请。

缺省子命令为 list。
  • apic member-invitations - 成员邀请集合操作。
  • apic member-invitations:clear - 删除所有成员邀请。
  • apic member-invitations:create - 创建成员邀请。
  • apic member-invitations:delete - 按名称或标识删除成员邀请。
  • apic member-invitations:get - 按名称或标识获取成员邀请对象。
  • apic member-invitations:list - 列示所有成员邀请。
  • apic member-invitations:update - 按名称或标识更新成员邀请。
apic orgs 列示和管理提供者组织和管理组织。

缺省子命令为 list。
  • apic orgs － 组织集合操作
  • apic orgs:clear - 删除所有组织
  • apic orgs:create - 创建组织
  • apic orgs:delete - 按名称或标识删除组织
  • apic orgs:get - 按名称或标识获取组织对象
  • apic orgs:list - 列示所有组织
  • apic orgs:transfer-owner - 转移组织的所有权
  • apic orgs:update - 按名称或标识更新组织
apic org-settings 管理提供者组织和管理组织的设置。
  • apic org-settings:get - 获取组织的设置对象
  • apic org-settings:update - 更新组织的设置
apic policies 列示并管理目录中的策略。

缺省子命令为 list。
  • apic policies － 策略集合操作
  • apic policies:clear － 清除策略
  • apic policies:clear-all － 清除所有集合中的所有策略
  • apic policies:create － 创建策略
  • apic policies:delete － 删除策略
  • apic policies:get － 按名称和版本获取策略
  • apic policies:list － 列示策略
  • apic policies:list-all － 列示所有集合中的所有策略
  • apic policies:update － 按名称和版本更新策略
apic products 列示和管理已登台或已发布到目录或 空间的产品。

缺省子命令为 list-all。
  • apic products － 产品集合操作
  • apic products:clear - 按名称删除产品的所有版本
  • apic products:clear-all - 删除所有产品
  • apic products:delete - 按名称和版本删除产品
  • apic products:execute-migration-target － 产品执行迁移目标操作
  • apic products:get - 按名称和版本获取产品对象
  • apic products:list - 按名称列示产品的所有版本
  • apic products:list-all - 列示所有产品
  • apic products:publish - 通过提供产品定义 YAML 文件，将产品发布到目录或空间
  • apic products:replace - 将产品替换为其他产品
  • apic products:set-migration-target - 设置目标产品以从某产品迁移预订
  • apic products:supersede - 使用其他产品取代某产品
  • apic products:update - 通过提供修改的产品定义 YAML 文件，按名称和版本更新产品
apic identity-providers 查看有关身份提供者的信息。
  • apic identity-providers - 身份提供者操作
  • apic identity-providers:list - 列示身份提供者。
apic spaces 列出和管理目录中包含的 空间 。

缺省子命令为 list。
  • apic spaces － 空间集合操作
  • apic spaces:clear - 删除目录中的所有空间
  • apic spaces:create － 在目录中创建空间
  • apic spaces:delete - 按名称或标识删除目录中的空间
  • apic spaces:get - 按名称或标识获取空间对象
  • apic spaces:list - 列示目录中的所有空间
  • apic spaces:transfer-owner - 将空间所有权移交给其他用户
  • apic spaces:update - 按名称或标识更新空间
apic subscriptions 列示并管理产品或目录中的预订。

缺省子命令为 list。
  • apic subscriptions － 预订集合操作
  • apic subscriptions:clear － 清除预订
  • apic subscriptions:create － 创建预订
  • apic subscriptions:delete － 按名称或标识删除预订
  • apic subscriptions:get － 按名称或标识获取预订
  • apic subscriptions:list － 列示预订
  • apic subscriptions:update － 按名称或标识更新预订
表 3. API 开发人员和管理员的其他命令摘要
命令 描述 子命令
apic consumer-orgs 管理使用者组织
  • apic consumer-orgs － 使用者组织集合操作。
  • apic consumer-orgs:clear － 清除使用者组织。
  • apic consumer-orgs:create － 创建使用者组织。
  • apic consumer-orgs:delete － 按名称或标识删除使用者组织。
  • apic consumer-orgs:get － 按名称或标识获取使用者组织。
  • apic consumer-orgs:list － 列示使用者组织。
  • apic consumer-orgs:transfer-owner － 将所有者转移到新成员。
  • apic consumer-orgs:update － 按名称或标识更新使用者组织。
apic consumer-org-settings 管理使用者组织设置
  • apic consumer-org-settings:delete － 删除使用者组织设置。
  • apic consumer-org-settings:get － 获取使用者组织设置。
  • apic consumer-org-settings:update － 更新使用者组织设置。
apic groups 管理组
  • apic groups － 组集合操作。
  • apic groups:clear － 清除组。
  • apic groups:create － 创建组。
  • apic groups:delete － 按名称或标识删除组。
  • apic groups:get － 按名称或标识获取组。
  • apic groups:list － 列示组。
  • apic groups:update － 按名称或标识更新组。
apic invitations 管理邀请。

在邀请用户成为提供者组织、使用者组织、目录或空间的所有者时，创建邀请。
  • apic invitations - 邀请集合操作。
  • apic invitations:clear - 删除所有邀请。
  • apic invitations:create - 创建邀请。
  • apic invitations:delete - 按名称或标识删除邀请。
  • apic invitations:get - 按名称或标识获取邀请的详细信息。
  • apic invitations:list - 列示所有邀请。
  • apic invitations:update - 按名称或标识更新邀请。
apic member-invitations 管理成员邀请。

在邀请用户成为提供者组织、使用者组织、目录或空间的成员时，创建成员邀请。
  • apic member-invitations - 成员邀请集合操作。
  • apic member-invitations:clear - 删除所有成员邀请。
  • apic member-invitations:create - 创建成员邀请。
  • apic member-invitations:delete - 按名称或标识删除成员邀请。
  • apic member-invitations:get - 按名称或标识获取成员邀请的详细信息。
  • apic member-invitations:list - 列示所有成员邀请。
  • apic member-invitations:update - 按名称或标识更新成员邀请。
apic members
  • apic members － 成员集合操作。
  • apic members:clear － 清除成员。
  • apic members:create － 创建成员。
  • apic members:delete － 按名称或标识删除成员。
  • apic members:get － 按名称或标识获取成员。
  • apic members:list － 列示成员。
  • apic members:update － 按名称或标识更新成员。
apic registrations
  • apic registrations － 注册集合操作。
  • apic registrations:clear － 清除注册。
  • apic registrations:create － 创建注册。
  • apic registrations:delete － 按名称或标识删除注册。
  • apic registrations:get － 按名称或标识获取注册。
  • apic registrations:list － 列示注册。
  • apic registrations:update － 按名称或标识更新注册。
apic role-defaults
  • apic role-defaults － 角色缺省值集合操作。
  • apic role-defaults:clear － 清除角色缺省值。
  • apic role-defaults:create － 创建角色缺省值。
  • apic role-defaults:delete － 按名称或标识删除角色缺省值。
  • apic role-defaults:get － 按名称或标识获取角色缺省值。
  • apic role-defaults:list － 列示角色缺省值。
  • apic role-defaults:list-all － 列示所有集合中的所有角色缺省值。
  • apic role-defaults:update － 按名称或标识更新角色缺省值。
apic roles
  • apic roles － 角色集合操作。
  • apic roles:clear － 清除角色。
  • apic roles:create － 创建角色。
  • apic roles:delete － 按名称或标识删除角色。
  • apic roles:get － 按名称或标识获取角色。
  • apic roles:list － 列示角色。
  • apic roles:update － 按名称或标识更新角色。
apic tasks
  • apic tasks － 任务集合操作。
  • apic tasks:clear － 清除任务。
  • apic tasks:create － 创建任务。
  • apic tasks:delete － 按名称或标识删除任务。
  • apic tasks:get － 按名称或标识获取任务。
  • apic tasks:list －列示任务。
  • apic tasks:update － 按名称或标识更新任务。
apic user-registries
  • apic user-registries － 用户注册表集合操作。
  • apic user-registries:clear － 清除用户注册表。
  • apic user-registries:create － 创建用户注册表。
  • apic user-registries:delete － 按名称或标识删除用户注册表。
  • apic user-registries:execute － 执行用户注册表操作。
  • apic user-registries:get － 按名称或标识获取用户注册表。
  • apic user-registries:list － 列出用户注册表。
  • apic user-registries:search - 在用户注册表中搜索用户。
  • apic user-registries:test-connection － 测试用户注册表连接。
  • apic user-registries:update － 按名称或标识更新用户注册表。
apic user-registry-settings
  • apic user-registry-settings:delete － 删除用户注册表设置。
  • apic user-registry-settings:get － 获取用户注册表设置。
  • apic user-registry-settings:update － 更新用户注册表设置。
apic users
  • apic users － 用户集合操作。
  • apic users:clear － 清除用户。
  • apic users:create － 创建用户。
  • apic users:delete － 按名称或标识删除用户。
  • apic users:get － 按名称或标识获取用户。
  • apic users:list － 列出用户。
  • apic users:request-password-reset - 发送密码重置链接。
  • apic users:search-provider - 从组织搜索提供者用户。
  • apic users:update － 按名称或标识更新用户。
apic test 测试您的 API
  • apic test {yaml-files} - 定义测试。
  • apic test {yaml-files} --insecureSkipVerify - 在禁用证书验证的情况下测试 API。
  • apic test {yaml-files} --certPath={location of certs folder} - 如果系统密钥库中没有该 CA 证书，则指定其位置。
  • api test {yaml-files} --mTLS --certPath={location of certs folder} - 在 mTLS 启用该功能的情况下测试 API。
  • api test {yaml-files} --config-file={location of config file} - 通过传递外部配置来定义测试。