内部错误 ——GraphQL 使用中的常见错误-JavaScript中文网-JavaScript教程资源分享门户

GraphQL是一个新兴的查询语言和运行时，专门用于API开发。它能够解决REST API的许多问题，如过多的请求和不确定的响应格式。GraphQL的学习曲线不是很陡峭，但是在使用GraphQL时仍然会遇到许多问题。在本文中，我们将讨论GraphQL使用中的常见错误，以及如何解决这些问题。

类型错误

类型错误是GraphQL中最常见的错误之一。它们通常在查询语句中引用不存在的类型时发生。例如，如果我们查询一个名为"Post"的类型，而该类型不在我们的GraphQL schema中定义，那么我们就会收到一个类型错误。

query {
  posts {
    title
  }
}

错误信息：

"message": "Cannot query field 'posts' 
on type 'Query'. Did you mean 'post'?"

这里我们使用的是"posts"而不是"post"类型。我们可以查看GraphQL schema来确定我们查询的类型是否存在。

-- -------------------- ---- -------
---- ----- -
  -------- ----- ----
-

---- ---- -
  --- ---
  ------ -------
  ----- -------
-

在这种情况下，我们只需要将查询的类型从"posts"更改为"post"即可修复这个错误。

GraphQL查询语言具有非常严格的语法规则。如果查询语句中存在任何语法错误，GraphQL会返回一个非常详细的错误消息，指出错误发生的位置和类型。

例如，我们忘记在查询语句中添加"{"和"}"，将导致语法错误。

query 
  posts {
    title
  }

错误信息：

"message": "Syntax Error: Expected { but 
found Name 'posts'"

这个错误告诉我们在第一行第一个字符处期望一个"{"符号，但是找到了名称"posts"。我们只需添加"{"和"}"就能修复错误。

query {
  posts {
    title
  }
}

在GraphQL中，我们可以使用变量来传递参数。这对于避免代码重复以及使用相同查询格式但不同参数的情况非常有用。类似于函数中传递参数，GraphQL查询也可以使用变量。

query GetPost($id: ID!) {
  post(id: $id) {
    title
    body
  }
}

在这个例子中，我们定义了查询语句的参数"$id"，这个参数是一个ID类型。我们可以在GraphQL客户端中传递变量值来进行查询。但是，如果我们启动查询而没有传递必需的变量，则会收到一个变量错误。

{
  "id": "123",
  "title": "GraphQL is awesome!"
}

错误信息：

"message": "Variable 
'$id' of type 'ID!' is required 
and cannot be null."

这个错误告诉我们需要一个ID类型的参数"$id"来成功运行查询。我们只需传递一个正确的变量就能修复这个错误。

GraphQL查询语句可能会由于服务器错误而失败。在这种情况下，我们可能会得到一个非常简单的错误消息，可能只是告知我们发生了一个内部服务器错误。

query {
  posts {
    title
  }
}

错误信息：

"message": "Internal Server Error"

这时候很难确定错误在哪里发生。为了解决这个问题，我们可以使用GraphQL调试工具，例如GraphiQL / Playground。这些工具可以让我们逐步调试GraphQL查询，以查找错误发生的位置。

在本篇文章中，我们分析了GraphQL使用中的常见错误，并讨论了如何解决这些错误。GraphQL具有它自己的学习曲线，但是一旦熟悉了它的语法和概念，它可以为我们的API带来很多好处。实践出真知，如果在使用GraphQL时遇到任何问题，请保持耐心，并使用我们的经验来识别和修复错误。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/674d25cda336082f25497329