PHPGraphQL怎么使用_PHP实现GraphQLAPI-php教程-PHP中文网

PHPGraphQL怎么使用_PHP实现GraphQLAPI

雪夜

发布： 2025-10-10 11:49:01

原创

182人浏览过

使用webonyx/graphql-php可快速搭建PHP的GraphQL API：先通过Composer安装库，定义User对象类型及包含user查询的Schema，编写resolve函数模拟数据返回，创建schema实例并在入口文件处理请求，最终返回JSON响应，支持前端调用。

phpgraphql怎么使用_php实现graphqlapi

PHP 中实现 GraphQL API 主要是通过 Webonyx/GraphQL-PHP 这个库，它是 PHP 社区中最成熟、最广泛使用的 GraphQL 实现。下面带你一步步搭建一个简单的 GraphQL API 服务。

1. 安装 Webonyx GraphQL-PHP

使用 Composer 安装官方库：

composer require webonyx/graphql-php

确保你的项目已初始化 Composer（即有 composer.json 文件）。

2. 定义 Schema 和类型

GraphQL 的核心是定义 schema，包括查询（Query）、变更（Mutation）和各种对象类型。

例如，我们构建一个简单的“用户”查询 API：

ViiTor实时翻译

AI实时多语言翻译专家！强大的语音识别、AR翻译功能。

116

查看详情

创建 User 类型：

use GraphQL\Type\Definition\Type;
use GraphQL\Type\Definition\ObjectType;

$userType = new ObjectType([
    'name' => 'User',
    'fields' => [
        'id'   => Type::nonNull(Type::int()),
        'name' => Type::string(),
        'email' => Type::string(),
    ]
]);

登录后复制

定义根查询类型：

$queryType = new ObjectType([
    'name' => 'Query',
    'fields' => [
        'user' => [
            'type' => $userType,
            'args' => [
                'id' => Type::int()
            ],
            'resolve' => function ($root, $args) {
                // 模拟数据
                $users = [
                    1 => ['id' => 1, 'name' => 'Alice', 'email' => 'alice@example.com'],
                    2 => ['id' => 2, 'name' => 'Bob', 'email' => 'bob@example.com'],
                ];
                return $users[$args['id']] ?? null;
            }
        ]
    ]
]);

登录后复制

3. 创建 Schema 实例

将查询类型组合成完整的 schema：

use GraphQL\Type\Schema;

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

登录后复制

4. 处理 GraphQL 请求

在入口文件（如 index.php）中接收请求并返回结果：

use GraphQL\GraphQL;

$input = json_decode(file_get_contents('php://input'), true);
$query = $input['query'];
$variableValues = $input['variables'] ?? null;

try {
    $result = GraphQL::executeQuery($schema, $query, null, null, $variableValues);
    $output = $result->toArray();
} catch (\Exception $e) {
    $output = [
        'error' => [
            'message' => $e->getMessage()
        ]
    ];
}

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

登录后复制

5. 测试你的 GraphQL API

发送 POST 请求到你的 PHP 文件（比如 http://localhost/graphql.php）：

请求体示例：

立即学习“PHP免费学习笔记（深入）”；

{
  "query": "{ user(id: 1) { id name email } }"
}

登录后复制

你将收到类似以下的 JSON 响应：

{
  "data": {
    "user": {
      "id": 1,
      "name": "Alice",
      "email": "alice@example.com"
    }
  }
}

登录后复制

6. 可选：集成到框架（如 Laravel 或 Symfony）

如果你使用 Laravel，可以考虑使用扩展包如 rebing/graphql-laravel，它封装了 webonyx/graphql-php 并提供路由、中间件、配置文件等支持。

安装方法：
composer require rebing/graphql-laravel
然后按文档发布配置并注册 schema。

总结

PHP 实现 GraphQL API 的关键是：

使用 webonyx/graphql-php 定义类型和 schema
编写 resolve 函数获取真实数据（可连接数据库）
通过入口脚本解析请求并返回 JSON 响应
前端可用 Apollo、Relay 或简单 fetch 调用

基本上就这些，不复杂但容易忽略细节，比如类型非空声明、错误处理和参数验证。

以上就是PHPGraphQL怎么使用_PHP实现GraphQLAPI的详细内容，更多请关注php中文网其它相关文章！

大家都在看：

PHP如何截取字符串_字符串截取操作完整指南 php数据库如何实现数据压缩 php数据库存储空间节省方案 php工具如何使用GraphQL构建API_php工具数据查询语言的集成方案 PHP缓存怎么预热_PHP缓存预热方法及性能提升策略。 php 正则怎么用_PHP正则表达式使用方法教程