Apollo/GraphQL field type for object with dynamic keys

Question

Let's say my graphql server wants to fetch the following data as JSON where person3 and person5 are some id's:
"persons": {
  "person3": {
    "id": "person3",
    "name": "Mike"
  },
  "person5": {
    "id": "person5",
    "name": "Lisa"
  }
}

Question: How to create the schema type definition with apollo?

The keys person3 and person5 here are dynamically generated depending on my query (i.e. the area used in the query). So at another time I might get person1, person2, person3 returned. As you see persons is not an Iterable, so the following won't work as a graphql type definition I did with apollo:
type Person {
  id: String
  name: String
}
type Query {
  persons(area: String): [Person]
}

The keys in the persons object may always be different.

One solution of course would be to transform the incoming JSON data to use an array for persons, but is there no way to work with the data as such?

Ritesh swamy · Accepted Answer

GraphQL relies on both the server and the client knowing ahead of time what fields are available available for each type. In some cases, the client can discover those fields (via introspection), but for the server, they always need to be known ahead of time. So to somehow dynamically generate those fields based on the returned data is not really possible. You could utilize a custom JSON scalar and return that for your query: type Query { persons(area: String): JSON } By utilizing JSON, you bypass the requirement for the returned data to fit any specific structure, so you can send back whatever you want as long it's properly formatted JSON. Of course, there's significant disadvantages in doing this. For example, you lose the safety net provided by the type(s) you would have previously used (literally any structure could be returned, and if you're returning the wrong one, you won't find out about it until the client tries to use it and fails). You also lose the ability to use resolvers for any fields within the returned data.

Sumit Sharma · Answer

You can write your own GraphQLScalarType and precisely describe your object and your dynamic keys, what you allow and what you do not allow or transform. read here. See https://graphql.org/graphql-js/type/#graphqlscalartype You can have a look at taion/graphql-type-json where he creates a Scalar that allows and transforms any kind of content:

GraphQL

Similar Questions

Why does a GraphQL query return null?

How to get requested fields inside GraphQL resolver?

How to check permissions and other conditions in GraphQL query?

On a mission to build Next-Gen Community Platform for Developers

Facebook

Twitter

Linkedin

Instagram