GraphQuill：在VS Code中无缝测试GraphQL API

项目介绍

GraphQuill 是一款专为 VS Code 设计的扩展插件，旨在简化 GraphQL API 端点的测试流程。通过 GraphQuill，开发者无需在 VS Code 和 GraphiQL、Postman 等外部工具之间来回切换，即可直接在 VS Code 环境中进行 GraphQL 查询和突变的测试。GraphQuill 不仅支持本地和 Docker 化的服务器，还兼容外部 API，极大地提升了开发效率。

项目技术分析

核心功能

1. 自动启动服务器：GraphQuill 能够自动检测并启动本地或 Docker 化的 GraphQL 服务器。如果服务器已在指定端口运行，GraphQuill 会直接连接。
2. 解析 GraphQL 查询/突变：GraphQuill 能够解析当前 VS Code 文档中的 GraphQL 查询和突变语句。
3. 发送请求并渲染响应：GraphQuill 将解析后的查询/突变发送到 GraphQL API，并将响应结果渲染在 VS Code 的输出通道中。

附加功能

• 输出当前 GraphQL 模式：GraphQuill 可以在输出通道中显示当前 GraphQL API 的模式。
• 开源的 Mock GraphQL API：GraphQuill 团队开源了两个用于测试的 GraphQL API 项目，分别支持 Docker 化和本地数据库（PostgreSQL 和 MongoDB）。

项目及技术应用场景

GraphQuill 适用于以下场景：

• 前端开发者：在进行 GraphQL 查询和突变测试时，无需离开 VS Code 环境，即可快速验证 API 响应。
• 后端开发者：在开发和调试 GraphQL API 时，GraphQuill 提供了一个便捷的工具，帮助开发者快速测试 API 端点。
• 全栈开发者：GraphQuill 的一体化设计使得全栈开发者可以在同一个环境中完成前后端的开发和测试工作。

项目特点

• 无缝集成：GraphQuill 与 VS Code 无缝集成，开发者无需切换工具即可完成 API 测试。
• 支持多种服务器环境：无论是本地服务器、Docker 化的服务器，还是外部 API，GraphQuill 都能轻松应对。
• 开源的测试 API：GraphQuill 提供了开源的 Mock GraphQL API，方便开发者快速上手和测试。
• 自动解析与发送：GraphQuill 能够自动解析文档中的 GraphQL 语句，并在保存时自动发送请求，极大地简化了测试流程。

如何开始使用

安装

GraphQuill 可以通过 VS Code 扩展市场直接安装，点击这里进行安装。

配置文件设置

在 VS Code 中打开命令面板（Cmd/Ctrl + Shift + P），选择 "GraphQuill: Create GraphQuill Config File" 生成默认配置文件。根据你的服务器类型（本地或外部），更新配置文件中的入口点和端口号。详细配置说明请参考文档。

编写第一个 GraphQuill 查询

在命令面板中搜索并运行 "GraphQuill: Activate" 命令。如果 graphQuill 函数未定义，GraphQuill 会自动在文件顶部注入函数定义。在文件中编写 GraphQL 查询，例如：

graphQuill(`{
  customer (customerId: 8) {
    firstName
    lastName
    email
  }  
}`);

graphQuill('{ product (productId: 26) { name description weight } }');

每次保存文件时，GraphQuill 都会自动发送查询请求，并在输出通道中显示响应结果。

贡献与反馈

GraphQuill 团队欢迎开发者贡献代码、提出功能请求或报告问题。详细信息请参考贡献指南、功能请求和问题报告。

发布说明

GraphQuill 由 Alex Chao、Austin Ruby 和 Edward Greenberg 创建，版本 0.16.0 为初始发布，更多功能即将推出！

---

通过 GraphQuill，开发者可以在 VS Code 中轻松进行 GraphQL API 测试，提升开发效率，减少工具切换的繁琐。立即安装 GraphQuill，体验无缝的 GraphQL 测试流程吧！