kolah/php-graphql-client-generator-cli

PHP GraphQL客户端生成库的CLI工具

v1.0.2 2018-10-01 13:28 UTC

This package is auto-updated.

Last update: 2024-09-15 02:43:09 UTC


README

这是什么?

这是PHP GraphQL客户端生成器的CLI版本,它可以从GraphQL模式文件生成强类型PHP客户端。

在创建此工具时,没有合适的方法来利用PHP中的GraphQL API。

此工具基于camuthig/php-graphql-client-generator

要求

  • PHP 7.1

安装

PHAR(推荐)

运行安装程序并将带有签名的PHAR文件下载到当前目录

curl -LSs https://kolah.github.io/php-graphql-client-generator-cli/installer.php | php

注意:如果您想重命名命令以去除.phar扩展名或将工具移动到其他目录,请注意PHAR二进制文件已签名,并且需要.pubkey文件才能工作,因此您需要相应地重命名签名文件,例如mv gql2php.phar gql2php && mv gql2php.phar.pubkey gql2php.pubkey

Composer(全局)

composer global require kolah/php-graphql-client-generator-cli

用法

客户端生成

为了生成客户端,使用gql2php generate。该generate命令期望一些必需的参数

  • -s--schema:GraphQL模式文件的路径,例如:./schema.graphqls
  • -ns--namespace:放置生成的代码的命名空间,例如:"Kolah\Client"
  • -o--output-dir:输出生成的代码的基本目录,例如:src/Kolah/Client

gql2php提供通过提供GraphQL类型到完全限定类名的映射来覆盖生成的代码的能力

  • -m--map "Time:Kolah\Client\Extended\Time"

为了使用生成的代码,需要基础客户端作为依赖项

composer require kolah/php-graphql-client-base

自我更新(PHAR版本)

此应用程序提供自我更新机制。要检查更新并自动更新工具,请使用gql2php update。如果在找到较新版本时,会备份旧版本。

如果您有一个存储的旧版本,可以使用gql2php update --rollback回滚到先前的版本。

注意:对于composer全局安装,请使用composer global update kolah/php-graphql-client-generator-cli