GraphQL 是一种用于提供 API 的查询语言和运行时环境。GraphQL Schema 是 GraphQL API 的核心部分，定义了 API 中的数据类型、查询方法和 mutations。然而，由于 GraphQL Schema 的复杂性和灵活性，常常会出现常见的错误。本篇文章将介绍这些错误，并提供避免这些错误的建议。
1. 没有定义 Query 和 Mutation 类型
在 GraphQL Schema 中必须定义 Query 和 Mutation 类型。如果未定义，GraphQL 将无法识别查询和变更操作。下面是示例 GraphQL Schema，其中定义了 Query 和 Mutation 类型：
type Query {
hero: Character
droid(id: ID!): Droid
}
type Mutation {
createReview(episode: Episode!, review: ReviewInput!): Review
}查询类型（Query）定义了查询操作。变更类型（Mutation）定义了写操作。hero 和 droid 是查询操作，createReview 是写操作。在这个例子中，Query 类型返回 Character 类型的 hero 字段和 Droid 类型的 droid 字段。Mutation 类型返回 Review 类型的 createReview 字段。
2. 类型定义错误
在 GraphQL Schema 中，如果定义了错误的类型，GraphQL 将无法解析查询。下面是一个样例：
type Person {
name: String,
age: Int
}
type Query {
person: Peron
}在这个例子中，person 字段的类型定义错误。应该是 Person （注意两个字母的拼写）而不是 Peron 。这个错误会导致 GraphQL 无法解析查询语句。
3. 缺少查询参数
在 GraphQL Schema 中，如果定义了查询参数，但在查询语句中未提供参数，GraphQL 将抛出错误。下面是一个样例：
type Query {
hero(episode: Episode!): Character
}
query {
hero
}在这个例子中，查询语句中未提供 episode 参数，因此 GraphQL 无法解析查询。为避免这种错误，应该提供必需的参数。
4. 不同类型的字段具有重复名字
在 GraphQL Schema 中，如果不同类型的字段具有相同的名称，GraphQL 将无法解析查询语句。下面是一个样例：
-- -------------------- ---- ------- ---- --------- - ----- ------ - ---- ----- - ----- ------ - ---- ----- - ----- --------- ------ ----- -
在这个例子中，Character 和 Droid 类型都有一个名为 name 的字段。如果在查询语句中使用 name 字段，GraphQL 将无法确定使用哪种类型的字段。为避免这种错误，应将不同类型的字段命名为不同的名称。
5. 内置类型错误
在 GraphQL Schema 中，如果使用错误的内置类型，GraphQL 将无法遵循规范的类型转换。下面是一个样例：
type Query {
echo(input: String): String
}在这个例子中，input 字段的类型应该是 String ，而不是 string 。这个错误会导致 GraphQL 无法解析查询语句。
6. 没有正确地定义可选参数
在 GraphQL Schema 中，如果定义了可选的参数，但在查询语句中使用了不存在的参数，或者未提供可选参数的默认值，GraphQL 将抛出错误。下面是一个样例：
type Query {
search(text: String, limit: Int = 10): [SearchResult]
}
query {
search(text: "GraphQL", page: 5)
}在这个例子中，page 参数不存在，因此会导致 GraphQL 发生错误。为避免这种错误，应当正确地定义可选参数并提供默认值。
7. 没有定义枚举类型
在 GraphQL Schema 中，如果没有定义枚举类型，GraphQL 将无法识别枚举值。下面是一个示例：
-- -------------------- ---- ------- ---- ------- - -------- ------ ---- - ---- ----- - ------------- ---------- --------- -
在这个示例中，枚举类型 Episode 定义了 NEW_HOPE 、 EMPIRE 和 JEDI 三个值。查询类型 hero 运行一个带有 episode 参数的查询，该参数是必须的，且该参数值必须时 Episode 类型。没有定义枚举类型将导致 GraphQL 无法解析查询语句。
8. 没有正确地定义联合类型
在 GraphQL Schema 中，如果没有正确地定义联合类型，GraphQL 将无法正确地解析查询语句。下面是一个示例：
-- -------------------- ---- ------- ---- ----- - ----- ------ ----------- ------ - ---- ----- - ----- ------ ---------------- ------ - ----- ------------ - ----- - ----- ---- ----- - ------------ -------- -------------- -
在这个示例中，联合类型 SearchResult 定义了可以返回 Human 或 Droid 类型的结果。查询类型 search 返回 SearchResult 类型的数组。没有正确定义联合类型将导致 GraphQL 无法解析查询语句。
结论
本文介绍了 GraphQL Schema 中的一些常见错误以及如何避免它们。GraphQL 是一个强大而灵活的工具，但仍然需要遵守 Schema 的规范。通过避免这些错误，我们可以创建稳健的 GraphQL API，并通过与数据的有效交互来提高应用程序的性能。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6735bb730bc820c5825028a5