PHP怎样处理GraphQL内省 GraphQL内省查询技巧解析-php教程-PHP中文网

PHP怎样处理GraphQL内省 GraphQL内省查询技巧解析

尼克

发布： 2025-07-08 15:04:01

原创

363人浏览过

php处理graphql内省需先配置服务器控制内省访问，再通过权限验证防止敏感信息泄露。具体步骤为：1. 使用webonyx/graphql-php库时，默认允许内省，可通过disableintrospection选项禁用；2. 更佳实践是结合用户权限控制内省访问，而非直接禁用；3. 使用__schema元字段执行内省查询以获取api结构；4. 通过中间件或指令标记敏感字段，限制未授权用户访问；5. 定期审查schema与权限设置，确保数据安全。

PHP怎样处理GraphQL内省 GraphQL内省查询技巧解析

PHP处理GraphQL内省主要涉及配置GraphQL服务器以允许或限制内省查询，并了解如何利用内省来理解GraphQL API的结构。简单来说，就是控制谁能看到你的API蓝图，以及如何利用这个蓝图。

GraphQL内省是一个强大的工具，允许客户端查询GraphQL服务器的schema，从而发现可用的类型、字段、查询和变更。然而，不当使用可能暴露敏感信息。

GraphQL内省查询技巧解析

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

如何在PHP的GraphQL服务器中启用或禁用内省？

在PHP的GraphQL服务器中，启用或禁用内省通常取决于你使用的GraphQL库。例如，在使用webonyx/graphql-php库时，你可以在配置中控制内省的开启和关闭。

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

// 定义你的查询类型
$queryType = new ObjectType([
    'name' => 'Query',
    'fields' => [
        'hello' => [
            'type' => Type::string(),
            'resolve' => function () {
                return 'Hello World!';
            },
        ],
    ],
]);

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

// 允许内省（默认情况下，webonyx/graphql-php允许内省）
// 你可以通过在执行查询时传递`disableIntrospection`选项来禁用内省
$rawInput = file_get_contents('php://input');
$input = json_decode($rawInput, true);
$query = $input['query'];
$variableValues = isset($input['variables']) ? $input['variables'] : null;

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

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


// 禁用内省示例 (不推荐直接禁用，而应该进行权限控制)
// $result = GraphQL::executeQuery($schema, $query, null, null, $variableValues, null, ['disableIntrospection' => true]);

登录后复制

关键在于，虽然webonyx/graphql-php默认允许内省，但更好的做法不是完全禁用它，而是根据用户的权限进行控制。例如，只有授权用户才能执行内省查询。这需要你在resolver中进行权限验证。

如何使用GraphQL内省查询来理解API结构？

要理解GraphQL API的结构，你可以使用__schema元字段执行内省查询。这个查询会返回一个包含API schema所有信息的JSON对象。

query IntrospectionQuery {
  __schema {
    queryType {
      name
    }
    mutationType {
      name
    }
    subscriptionType {
      name
    }
    types {
      name
      kind
      description
      fields {
        name
        description
        type {
          name
          kind
          ofType {
            name
            kind
          }
        }
        args {
          name
          description
          type {
            name
            kind
            ofType {
              name
              kind
            }
          }
        }
      }
      inputFields {
        name
        description
        type {
          name
          kind
          ofType {
            name
            kind
          }
        }
      }
      interfaces {
        name
      }
      enumValues {
        name
        description
      }
      possibleTypes {
        name
      }
    }
    directives {
      name
      description
      locations
      args {
        name
        description
        type {
          name
          kind
          ofType {
            name
            kind
          }
        }
      }
    }
  }
}

登录后复制

这个查询会返回一个巨大的JSON对象，包含了所有类型、字段、参数和指令的详细信息。你可以使用这个信息来构建GraphQL客户端，或者生成API文档。

例如，如果你想找到所有可用的查询，你可以查看__schema.types数组，找到kind为OBJECT且name为Query的类型。然后，你可以查看这个类型的fields属性，找到所有可用的查询。