Як запитувати всі поля типу GraphQL, не записуючи довгий запит?

Припустимо, у вас тип 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 - ви самостійно розбираєтесь, як читати та писати разом із фактичним клієнтом. Ваша бібліотека JavaScriptQL JavaScript вже може використовувати інтроспекцію в певній якості, наприклад, команда apollo codegen використовує інтроспекцію для генерування типів.

Я думаю, що єдиний спосіб зробити це - використовуючи фрагменти багаторазового використання:

fragment UserFragment on Users {
    id
    username
    count
} 

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

З цією ж проблемою я зіткнувся, коли мені потрібно було завантажити дані про місцезнаходження, які я серіалізував у базу даних через API google places. Як правило, я хотів би, щоб все це працювало з картами, але я не хотів кожного разу вказувати всі поля.

Я працював у Ruby, тому я не можу дати вам реалізацію PHP, але принцип повинен бути таким же.

Я визначив користувацький скалярний тип під назвою JSON, який просто повертає буквальний об'єкт JSON.

Реалізація рубіну виглядала так (використовуючи 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. https://www.apollographql.com/docs/apollo-server/schema/scalars-enums/#custom-scalars