如何在不编写长查询的情况下查询所有GraphQL类型字段?

2020/09/30 21:21 · php ·  · 0评论

假设您具有GraphQL类型,并且其中包含许多字段。如何在不写下包含所有字段名称的长查询的情况下查询所有字段?

例如,如果我有这些字段:

 public function fields()
    {
        return [
            'id' => [
                'type' => Type::nonNull(Type::string()),
                'description' => 'The id of the user'
            ],
            'username' => [
                'type' => Type::string(),
                'description' => 'The email of user'
            ], 
             'count' => [
                'type' => Type::int(),
                'description' => 'login count for the user'
            ]

        ];
    }

要查询所有字段,通常查询是这样的:

FetchUsers{users(id:"2"){id,username,count}}

但是我想要一种无需编写所有字段即可获得相同结果的方法,如下所示:

FetchUsers{users(id:"2"){*}}
//or
FetchUsers{users(id:"2")}

有没有办法在GraphQL中做到这一点?

我正在使用Folkloreatelier / laravel-graphql库。

不幸的是,您无法做的事情。GraphQL要求您明确指定要从查询中返回哪些字段。

是的,您可以使用自省功能进行GraphQL查询,例如(对于UserType类型

{
   __type(name:"UserType") {
      fields {
         name
         description
      }  
   }
}

然后您会收到类似的响应(实际的字段名称将取决于您的实际架构/类型定义)

{
  "data": {
    "__type": {
      "fields": [
        {
          "name": "id",
          "description": ""
        },
        {
          "name": "username",
          "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only."
        },
        {
          "name": "firstName",
          "description": ""
        },
        {
          "name": "lastName",
          "description": ""
        },
        {
         "name": "email",
          "description": ""
        },
        ( etc. etc. ...)
      ]
    }
  }
}

然后,您可以在客户端中读取此字段列表,并动态构建第二个GraphQL查询以获取所有这些字段。

这取决于您知道要获取其字段的类型的名称-如果您不知道类型,则可以使用内省法将所有类型和字段加在一起

{
  __schema {
    types {
      name
      fields {
        name
        description
      }
    }
  }
}

注意:这是在线GraphQL数据-您需要自己弄清楚如何与实际的客户端进行读写。您的graphQL javascript库可能已经以某种方式使用了自省功能,例如apollo codegen命令使用了自省功能来生成类型。

我想做到这一点的唯一方法是利用可重复使用的片段:

fragment UserFragment on Users {
    id
    username
    count
} 

FetchUsers {
    users(id: "2") {
        ...UserFragment
    }
}

当我需要从Google Places API加载序列化到数据库的位置数据时,我遇到了同样的问题。通常,我希望整个事情都可以在地图上使用,但是我不想每次都指定所有字段。

我当时在Ruby中工作,所以无法为您提供PHP实现,但原理应相同。

我定义了一个名为JSON的自定义标量类型,它仅返回一个文字JSON对象。

ruby的实现就像这样(使用graphql-ruby)

module Graph
  module Types
    JsonType = GraphQL::ScalarType.define do
      name "JSON"
      coerce_input -> (x) { x }
      coerce_result -> (x) { x }
    end
  end
end

然后我将它用于这样的对象

field :location, Types::JsonType

不过,我会非常谨慎地使用它,仅在您知道始终需要整个JSON对象的地方使用它(就像我在本例中所做的那样)。否则,从更广泛的意义上讲,它是在击败GraphQL的对象。

GraphQL查询格式旨在允许:

  1. 查询和结果形状都完全相同
  2. 服务器知道确切的必填字段,因此客户端下载唯一重要的数据。

但是,根据GraphQL文档,您可以创建片段以使选择集更可重用:

# Only most used selection properties

fragment UserDetails on User {
    id,
    username
} 

然后,您可以通过以下方式查询所有用户详细信息:

FetchUsers {
    users() {
        ...UserDetails
    }
}

您还可以在片段旁边添加其他字段

FetchUserById($id: ID!) {
    users(id: $id) {
        ...UserDetails
        count
    }
}

软件包graphql-type-json支持自定义标量类型JSON。使用它可以显示json对象的所有字段。这是ApolloGraphql Server中示例的链接。
https://www.apollographql.com/docs/apollo-server/schema/scalars-enums/#custom-scalars

本文地址:http://php.askforanswer.com/ruhezaibubianxiechangchaxundeqingkuangxiachaxunsuoyougraphqlleixingziduan.html
文章标签: ,   ,   ,  
版权声明:本文为原创文章,版权归 admin 所有,欢迎分享本文,转载请保留出处!

文件下载

老薛主机终身7折优惠码boke112

上一篇:
下一篇:

评论已关闭!