GraphQL PHP Scalars 使用教程

GraphQL PHP Scalars 使用教程

graphql-php-scalarsA collection of custom scalar types for usage with https://github.com/webonyx/graphql-php项目地址:https://gitcode.com/gh_mirrors/gr/graphql-php-scalars

项目介绍

graphql-php-scalars 是一个为 graphql-php 库提供自定义标量类型的开源项目。这些自定义标量类型可以帮助你在 GraphQL 查询中进行更严格的类型验证，例如电子邮件、日期、URL 等。

项目快速启动

安装

首先，你需要通过 Composer 安装 graphql-php-scalars：

composer require mll-lab/graphql-php-scalars

使用

以下是一个简单的示例，展示如何在你的 GraphQL 类型定义中使用自定义标量类型：

use GraphQL\Type\Definition\Type;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Schema;
use GraphQL\GraphQL;
use MLL\GraphQLScalars\Email;

$queryType = new ObjectType([
    'name' => 'Query',
    'fields' => [
        'exampleEmail' => [
            'type' => Email::type(),
            'resolve' => function () {
                return 'example@example.com';
            },
        ],
    ],
]);

$schema = new Schema([
    'query' => $queryType,
]);

$rawInput = file_get_contents('php://input');
$query = json_decode($rawInput, true)['query'];

$result = GraphQL::executeQuery($schema, $query);
$output = $result->toArray();

header('Content-Type: application/json');
echo json_encode($output);

应用案例和最佳实践

应用案例

假设你正在开发一个用户管理系统，你需要确保用户的电子邮件地址是有效的。你可以使用 Email 标量类型来实现这一点：

use MLL\GraphQLScalars\Email;

$userType = new ObjectType([
    'name' => 'User',
    'fields' => [
        'email' => [
            'type' => Email::type(),
        ],
    ],
]);

最佳实践

1. 使用自定义标量类型进行严格验证：在处理敏感数据（如电子邮件、URL 等）时，使用自定义标量类型可以确保数据的正确性。
2. 文档化自定义标量类型：确保在你的 GraphQL 文档中详细说明每个自定义标量类型的用途和验证规则。

典型生态项目

graphql-php-scalars 是 graphql-php 生态系统的一部分。以下是一些相关的项目和工具：

1. graphql-php：一个 PHP 实现的 GraphQL 服务器库。
2. webonyx/graphql-php：graphql-php 的主要仓库，提供了 GraphQL 规范的完整实现。
3. graphql-tools：一个用于构建和操作 GraphQL 模式的工具集，虽然主要用于 JavaScript，但其中的概念和工具可以为 PHP 开发者提供灵感。

通过结合这些工具和项目，你可以构建一个强大且灵活的 GraphQL API。

graphql-php-scalarsA collection of custom scalar types for usage with https://github.com/webonyx/graphql-php项目地址:https://gitcode.com/gh_mirrors/gr/graphql-php-scalars