graphql-by-pop/graphql-server

使用 PoP API 实现的 PHP GraphQL 服务器

5.0.0 2024-09-07 03:34 UTC

README

使用 PoP API 实现的 PHP GraphQL 服务器

安装

安装 GraphQL 服务器

遵循 GraphQL by PoP 安装页面 中的说明。

在 PoP 应用程序中安装库

通过 Composer

composer require graphql-by-pop/graphql-server

要启用美观的 API 端点 /api/graphql/,请遵循此处的说明。

开发

源代码托管在 GatoGraphQL monorepo,位于 GraphQLByPoP/packages/graphql-server

用法

初始化组件

\PoP\Root\App::stockAndInitializeModuleClasses([([
    \GraphQLByPoP\GraphQLServer\Module::class,
]);

支持 REST

通过安装 REST 包,GraphQL 服务器也可以从单一的事实源满足 REST 端点。

演示

运行在 WordPress 网站 上的 GraphQL API 部署在此端点下: https://newapi.getpop.org/api/graphql/

您可以通过以下客户端进行操作

PHP 版本

需求

  • 开发需要 PHP 8.1+
  • 生产需要 PHP 7.2+

支持的 PHP 功能

请查看 GatoGraphQL/GatoGraphQL 中支持的 PHP 功能列表

预览降级到 PHP 7.2

通过 Rector(dry-run 模式)

composer preview-code-downgrade

标准

PSR-1PSR-4PSR-12

要检查编码标准,请通过 PHP CodeSniffer 运行

composer check-style

要自动修复问题,请运行

composer fix-style

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

测试

要执行 PHPUnit,请运行

composer test

静态分析

要执行 PHPStan,请运行

composer analyse

报告问题

要报告错误或请求新功能,请在 GatoGraphQL monorepo 问题跟踪器 上进行。

贡献

我们欢迎对这个包的贡献,请在 GatoGraphQL monorepo(这个包的源代码托管处)进行。

请参阅 CONTRIBUTINGCODE_OF_CONDUCT 了解详细信息。

安全性

如果您发现任何与安全相关的问题,请通过电子邮件发送至 leo@getpop.org,而不是使用问题跟踪器。

致谢

许可协议

GNU通用公共许可证第2版(或更新版)。有关更多信息,请参阅许可文件