使用教程与 GraphQL 入门
第一步:选择或输入 GraphQL 端点
打开工具后,首先需要确定要连接的 GraphQL 端点。如果你是首次使用,建议从内置的示例端点开始。点击端点输入框旁边的预置端点按钮,选择 "Countries GraphQL" 作为第一个体验的端点。该端点提供全球国家和地区的数据,数据结构简单直观,适合学习 GraphQL 基础语法。如果你有自己的 GraphQL API,直接在端点输入框中输入服务器的 URL 地址(如 https://api.example.com/graphql)并按回车即可。
第二步:编写你的第一个查询
在左侧的 Query 编辑器中输入以下查询:{ countries { name capital population } }。这个查询的意思是:从 countries 字段中获取所有国家的名称、首都和人口信息。注意 GraphQL 查询不需要以分号结尾,字段名之间用空格或换行分隔。点击"执行"按钮(或按 Ctrl+Enter),右侧结果面板会显示所有国家的数据。你可以观察到,返回的数据结构与查询结构完全对应——这就是 GraphQL "所见即所得" 的特性。
第三步:使用查询参数
GraphQL 支持为查询添加参数来筛选数据。例如,查询指定国家的详细信息:{ country(code: "CN") { name capital currency languages { name } } }。这个查询使用 code 参数筛选出中国的数据,并请求了货币和语言信息。参数用括号括起来,放在字段名后面。你还可以使用参数来限制列表查询的结果数量,如 { countries(filter: { continent: { eq: "AS" } }) { name capital } } 只查询亚洲国家。
第四步:使用查询变量
为了避免在查询中硬编码参数值,GraphQL 支持使用变量。首先在查询中定义变量:query GetCountry($code: String!) { country(code: $code) { name capital population } }。然后切换到 Variables 标签页,输入变量值:{ "code": "CN" }。这种方式使得同一个查询可以复用于不同的参数值,提高了代码的可维护性。变量使用 $ 符号前缀定义,在查询中通过 $variableName 引用。
第五步:浏览 Schema 文档
点击右侧的"文档"标签页,可以查看当前 GraphQL 服务器的完整 Schema 文档。文档中列出了所有可用的 Query(查询)、Mutation(变更)和 Subscription(订阅)类型,以及每种类型的字段定义、参数和返回类型。例如,在 Countries Schema 中,你可以看到 country 字段接受 code 参数返回 Country 类型,countries 字段接受 filter 参数返回 Country 数组。文档是交互式的,点击字段名可以展开查看嵌套类型的详细信息。通过阅读文档,你可以了解服务器提供了哪些数据查询能力。
第六步:添加认证头
如果你的 GraphQL API 需要认证,切换到 Headers 标签页添加认证头。常见的认证方式包括:Bearer Token 认证,在 Header Name 中输入 Authorization,在 Value 中输入 Bearer your-token-here;API Key 认证,输入自定义的 Header Name(如 X-API-Key)和对应的值。添加的请求头会随每次查询一起发送到服务器。注意不要在公共环境中暴露真实的认证 Token。
第七步:编写 Mutation 查询
Mutation 用于修改服务器端的数据。例如:mutation { createCountry(input: { name: "New Country", code: "NC" }) { id name } }。Mutation 的语法与 Query 类似,但使用 mutation 关键字开头。Mutation 通常用于创建、更新或删除数据操作。编写 Mutation 前,建议先通过文档浏览器查看可用的 Mutation 类型和参数定义。
UD5工具箱