GraphQL 可选查询参数

Question

我知道您可以将模式中的参数设置为默认值，但是否可以limit在我的 GraphQL 模式中使参数参数完全可选？现在看来，当我在没有指定限制的情况下点击它时，我想这就是我得到的原因Int cannot represent non-integer value: undefinedconst schema = buildSchema(`   companies(limit: Int): [Company] ...)我希望能够跳过限制，以便获得所有公司。在 JS 中，我这样称呼它：query: `query {            companies(limit: ${limit}) {  ...但有时我不想指定限制。所以发生的事情是客户端正在发送crafters(limit: undefined)并且它可能正在尝试将其转换为 Int。我不确定如何不发送limit以及如何使整个参数可选。（我还从客户那里读到，我应该将参数指定为变量，就像query($limit: Int) {  companies(limit: $limit) {我从我的客户那里猜测的那样，来自JS？如果是这样，我将如何将我的 limit JS 变量发送到其中？

Answer 1

默认情况下，GraphQL 中的参数可以为空（即可选）。因此，如果您的类型定义如下所示：

companies(limit: Int): [Company]

您不需要做任何其他事情就可以成为limit可选的——它已经是了。如果你想成为必需的，你可以通过将 a 附加到这样的类型来limit使其不可为空：!

companies(limit: Int!): [Company]

您看到的错误与参数类型无关limit。问题在于您发送的查询，根据错误消息，它看起来像这样：

query ($limit: Int){
  companies (limit: undefined) {
    # ...
  }
}

这里有两个问题：第一，您正在定义一个变量（$limit），您实际上从未在查询中使用它（如第二个错误所示）。第二，您将限制设置为undefined，这不是 GraphQL 中的有效文字。

您应该使用变量将任何动态值传递给您的查询，而不是使用字符串插值。例如：

query ($limit: Int){
  companies (limit: $limit) {
    # ...
  }
}

如果变量可以为空（注意我们使用Int而不是Int!），那么它可以从请求中完全省略，有效地使参数的值在服务器端未定义。

Answer 2

下面是一个示例，说明如何在客户端上定义查询并传递非必需参数。不确定您的客户端配置，但您可能想使用像 graphql-tag 这样的库将字符串转换为 AST。

const GET_COMPANIES = gql`

  query Companies($limit: Int) {

    companies(limit: $limit) {

      ... // return fields

    }

  }

`;