apigateway1 命令行界面（CLI）允许您在终端中舒适地使用 Google apigateway 服务的大多数功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其重定向到文件，而不依赖于 shell 的功能。错误将打印到标准错误，并导致程序退出代码不为零。

如果请求数据结构，则这些数据结构将作为格式化打印的 JSON 返回，以便作为其他工具的输入。

有关 apigateway API 的其他所有信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-apigateway1-cli

在 GitHub 上找到源代码。

用法

此文档是从修订版 20240221 的 apigateway API 生成的。CLI 的版本为 5.0.4。

apigateway1 [options]
        projects
                locations-apis-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-apis-configs-delete <name> [-p <v>]... [-o <out>]
                locations-apis-configs-get <name> [-p <v>]... [-o <out>]
                locations-apis-configs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-apis-configs-list <parent> [-p <v>]... [-o <out>]
                locations-apis-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-apis-configs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-apis-configs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-apis-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-apis-delete <name> [-p <v>]... [-o <out>]
                locations-apis-get <name> [-p <v>]... [-o <out>]
                locations-apis-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-apis-list <parent> [-p <v>]... [-o <out>]
                locations-apis-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-apis-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-apis-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-gateways-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-gateways-delete <name> [-p <v>]... [-o <out>]
                locations-gateways-get <name> [-p <v>]... [-o <out>]
                locations-gateways-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-gateways-list <parent> [-p <v>]... [-o <out>]
                locations-gateways-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-gateways-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-gateways-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
  apigateway1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在 ~/.google-service-cli 目录中的 JSON 文件中，这些文件以 apigateway1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

以下段落中提供了有关各种类型持久数据的更多信息。

身份验证

大多数 API 需要用户对任何请求进行身份验证。如果是这样，则 作用域 确定了授予的权限集。这些的粒度通常不超过 只读 或 完全访问。

如果没有设置，系统将自动选择最小的可行范围，例如在调用只读方法时，它只会请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用的范围都在相应方法的 CLI 文档中记录。

第一次使用范围时，系统会询问用户权限。根据 CLI 的指示授予权限或拒绝。

如果用户验证了范围，相关信息将以 JSON 格式存储在配置目录中，例如 ~/.google-service-cli/apigateway1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授予的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用 Google 服务，它需要使用Google 开发者控制台进行注册。然后依次启用应用程序可能使用的 API。大多数 API 可以免费使用，并且有每日配额。

为了在不强制要求任何人注册自己的应用程序的情况下更方便地使用 CLI，CLI 配置了一个默认的应用程序密钥。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题： ~/.google-service-cli/apigateway1-secret.json，假设已为它启用了所需的 apigateway API。这样的密钥文件可以在 Google 开发者控制台的 APIs & auth -> Credentials -> Download JSON 下载，并直接使用。

有关如何设置 Google 项目和启用 API 的更多信息，请参阅官方文档。

调试

尽管 CLI 尽力提供可用的错误消息，但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以 原始形式 输出到标准错误。

使用 --debug 标志将错误以 Debug 表示形式打印到标准错误。

您可以考虑将标准错误重定向到文件以方便使用，例如 apigateway1 --debug <resource> <method> [options] 2>debug.txt。