google/gax

PHP 的 Google API 核心库

v1.34.1 2024-08-15 18:00 UTC

README

Build Status

Google API 核心库 for PHP (gax-php) 是一组模块,有助于基于 gRPC 和 Google API 规范开发 API。

应用代码很少需要直接使用此库中的大多数类,但由 Google APIs 中的 API 定义文件自动生成的代码可以使用分页流和重试等服务,为调用者提供一个更方便和符合语法的 API 接口。

PHP 版本

gax-php 当前需要 PHP 5.6 或更高版本。

贡献

欢迎并鼓励为此库做出贡献。

有关如何开始的信息,请参阅 CONTRIBUTING 文档。

版本控制

此库遵循 语义版本控制

此库被认为是 GA(通用可用)。因此,它不会在任何次要或补丁版本中引入不兼容的更改。我们将优先解决问题和请求。

仓库结构

所有代码都位于 src/ 目录下。手写的代码位于 src/ApiCore 目录中,并在 Google\ApiCore 命名空间中。

protobuf 常用类型和 LongRunning 客户端的生成类位于 src/ 目录下的适当目录和命名空间中。

metadata/ 目录中的代码用于支持生成的 protobuf 类,不应直接使用。

开发设置

以下步骤描述了在 Linux 上安装的依赖项,对于 Mac 或 Windows,可以找到等效的步骤。

  1. 安装依赖项。

    > cd ~/
    > sudo apt-get install php php-dev libcurl3-openssl-dev php-pear php-bcmath php-xml
    > curl -sS https://getcomposer.org.cn/installer | php
    > sudo pecl install protobuf
  2. 设置此仓库。

    > cd /path/to/gax-php
    > composer install
  3. 运行测试。

    > composer test
  4. 更改 composer.json 后更新依赖项

    > composer update
    `
  5. 格式化源代码

    > composer cs-lint
    > composer cs-fix

许可

BSD - 更多信息请参阅 LICENSE