Как правильно объявить запрос GraphQL без параметров
Я использую vs code + graphql-cli для проверки и проверки схемы. В следующем объявлении (в файле схемы graphql):
type Query {
users(): Int
}
Объявление users выше помечено как en error, но оно не создает никаких проблем (или предупреждений) сервером - это только vs code, и graphql lint сообщает об этом как об ошибке:
2:9 Syntax Error: Expected Name, found ) undefined
Если я добавлю в запрос параметр, например:
type Query {
users(n: Int): Int
}
тогда нет проблем, о которых сообщает vs code или graphql-cli. Как правильно объявить запрос graphql без параметров.
Ответы 1
Запросы, которые вы указываете в своей схеме, ведут себя так же, как любое другое поле определенного типа (основное отличие состоит в том, что их тип связан с определенной операцией). Если вы не хотите объявлять какие-либо аргументы для определенного поля, вы просто полностью опустите круглые скобки. То же самое касается запросов и мутаций:
type Query {
users: Int
}
Из спецификации:
Fields are conceptually functions which return values, and occasionally accept arguments which alter their behavior. These arguments often map directly to function arguments within a GraphQL server’s implementation.
Поэтому стоит отметить, что любое поле типа может иметь аргументы. Например, запрос может выглядеть так:
query UsersQuery {
users {
name
posts (onlyNew: true) {
title
}
}
}
А как насчет запрос с одним необязательным параметром? Как это должно быть определено, чтобы действовали и users(n: 100), и users()?
По умолчанию аргументы допускают значение NULL. Последнее никогда не будет действительным, потому что это неверный синтаксис. Если вы не передаете никаких аргументов, вам нужно опустить круглые скобки.
Есть ошибка GraphQL, которая делает его не удается проанализировать
users()как действительный запрос, хотя параметрnявляется необязательным. Вы вынуждены писатьusers, если все параметры отсутствуют.