学习如何使用PHP创建GraphQL API：构建API接口的步骤-php教程-PHP中文网

学习如何使用PHP创建GraphQL API：构建API接口的步骤

WBOY

发布： 2024-01-22 11:24:07

原创

675人浏览过

php api接口：如何创建graphql api?

GraphQL是一个用于API的查询语言，它可以让客户端精确地查询数据，避免浪费网络带宽和服务器资源。在本文中，我们将讨论如何使用PHP创建GraphQL API。

GraphQL API的工作原理

GraphQL API是基于查询语言的。客户端发送查询请求到服务器，服务器解析请求并返回相应数据。请求和响应都是以GraphQL语言格式发送和接收的。

GraphQL API还支持多级关联查询，客户端可以查询一些数据，然后在同一个查询中请求相关数据。这大大减少了网络带宽和服务器开销。

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

GraphQL API中有三个主要的概念：查询、类型和解析器。查询是客户端发送的请求，GraphQL类型是API中使用的对象，解析器是将请求转换为响应的代码。

创建GraphQL API

我们将使用PHP实现GraphQL API，并使用webonyx/graphql-php库来构建和解析查询。

首先，我们需要创建一些GraphQL类型，这些类型描述了API中的对象。以下是一个示例User类型：

use GraphQLTypeDefinitionType;
use GraphQLTypeDefinitionObjectType;

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

登录后复制

上面的代码创建了一个名为User的类型，包含三个字段：id、name和email。每个字段都有一个类型，Type::int()表示整数类型，Type::string()表示字符串类型。

接下来，我们需要创建一个解析器来处理查询。以下是一个示例用户查询解析器：

$rootValue = [
    'users' => [
        ['id' => 1, 'name' => 'Alice', 'email' => 'alice@example.com'],
        ['id' => 2, 'name' => 'Bob', 'email' => 'bob@example.com']
    ]
];

$resolver = function ($root, $args) {
    global $rootValue;

    if (isset($args['id'])) {
        foreach ($rootValue['users'] as $user) {
            if ($user['id'] == $args['id']) {
                return $user;
            }
        }
    } else {
        return $rootValue['users'];
    }
};

登录后复制

上面的代码创建了一个$rootValue数组，它包含了两个用户对象。$resolver函数会根据客户端发送的请求来返回相应的数据。如果请求带有id参数，将返回具有该id的用户信息，否则将返回所有用户信息。

最后，我们需要将上述类型和解析器绑定到GraphQL API中。以下是绑定代码：

use GraphQLGraphQL;
use GraphQLTypeSchema;

$schema = new Schema([
    'query' => new ObjectType([
        'name' => 'Query',
        'fields' => [
            'user' => [
                'type' => $userType,
                'args' => ['id' => Type::int()],
                'resolve' => $resolver
            ],
            'users' => [
                'type' => Type::listOf($userType),
                'resolve' => $resolver
            ]
        ]
    ])
]);

if (!empty($_POST['query'])) {
    $result = GraphQL::executeQuery($schema, $_POST['query']);
    echo json_encode($result->toArray());
}

登录后复制

上面的代码将用户类型和解析器绑定到GraphQL API中，并创建了一个查询对象。在查询对象中，我们可以定义多个查询，例如'user'和'users'。每个查询都需要指定其类型和解析器，解析器在检测到查询时将被调用。

然后，我们需要通过POST请求将查询发送到API中，并解析响应数据。以上述代码为例，我们会从API中获取响应JSON对象并直接输出。

总结

在本文中，我们介绍了如何使用PHP创建GraphQL API。我们讨论了GraphQL API的工作原理，并提供了一些示例代码来演示如何创建类型、解析器并将其绑定到API中。我们还使用webonyx/graphql-php库来简化API的构建和解析。如果您想了解更多关于GraphQL的信息，请参考GraphQL官方文档。

以上就是学习如何使用PHP创建GraphQL API：构建API接口的步骤的详细内容，更多请关注php中文网其它相关文章！