如何测试 GraphQL API?
您刚刚创建了一个 GraphQL API,并准备测试它。但是该从哪里开始呢?如何知道它是否正常工作?
测试 API 对于确保其正常运行并满足用户需求至关重要。但要知道从哪里开始以及测试哪些内容可能并非易事。
在本文中,我们将引导您完成 GraphQL API 的测试流程。我们将涵盖从初始测试到负载测试和性能监控的所有内容。读完本文后,您将确切了解如何测试 API,并距离正式发布更近一步。
什么是 GraphQL?
如果你不知道,Graph QL 是 Facebook 开发的一种 API 查询语言。它允许你以声明式的方式从 API 请求数据,从而更轻松地处理复杂的数据结构。
GraphQL 是一种用于 API 的查询语言,它提供了一个服务器端运行时,用于使用您为数据定义的类型系统执行查询。GraphQL 由您当前的代码和数据支持,而不依赖于任何数据库或存储引擎。
定义这些类型的种类和字段,然后为每种类型的每个字段提供函数以建立 GraphQL 服务。
GraphQL 正日益流行,许多开发者都渴望学习如何使用它。在本指南中,我们将介绍 Graph QL 的一些基础知识以及如何测试您的 Graph QL API。
为什么要使用它?
那么,为什么要使用 Graph QL?
原因如下:
-
简洁性:Graph QL 旨在让您轻松通过一次请求获取所需数据。这意味着总体上代码量更少,这始终是一件好事。
-
效率:使用 Graph QL,您可以在请求中指定所需的数据。这意味着服务器不必发送您不需要的额外数据,从而提高您的请求效率。
-
灵活性:Graph QL 足够灵活,可以用于任何数据,从字符串和数字等简单数据到图像和文件等更复杂的数据。
总的来说,Graph QL 是一款功能强大的工具,可以简化开发者的工作。所以,如果你正在使用 API,一定要尝试一下!
什么值得考虑?
现在,您已经了解了 Graph QL 是什么以及它为何如此重要,接下来就该学习测试 Graph QL API 时需要注意哪些事项了。您需要牢记以下几点:
-
字段的数据类型:它们是正确的数据类型吗?
-
数据的结构:数据的顺序是否正确?
-
类型之间的关系:是否返回了正确的关系?
-
权限:数据是否仅返回给有权限查看的人?
为了确保应用程序的查询、调整和模式在前端按预期运行,我们使用了 GraphQL API。
这些只是测试 Graph QL API 时需要记住的几件事。牢记这些因素,您就可以确保 API 正常运行,并且数据安全无虞。
如何测试 GraphQL API?
现在我们已经了解了测试 GraphQL API 的一些基础知识,让我们来讨论一下可以用来让您的生活更轻松的一些工具。
您可以在想要测试 Graph QL API 的电脑上做一些不同的事。
首先,您可以使用第三方测试工具,例如 GraphiQL。这是一个无需编写任何代码即可测试 API 的绝佳选择。
另一个选择是使用像 Postman 这样的工具。使用此工具,您可以向 API 发送 HTTP 请求并获取响应。如果您想测试 API 中的特定功能,这是一个很好的选择。
您也可以使用像 SoapUI 这样的工具。此工具允许您同时测试 SOAP 和 REST API。如果您想同时使用这两种请求来测试 API,这是一个绝佳的选择。
JavaScript 开发人员最喜爱的 GraphQL 功能测试工具。您可以通过与 Mocha 等工具集成,快速测试断言以确认 API 响应,并将其作为自动化测试套件的一部分。
对于 PC 用户来说,有几种不同的选择,比如GraphQL CLI。它是一个命令行界面,可以让你自动为你的架构生成测试,而且使用起来非常简单。
另一个不错的选择是Apollo Server游乐场。这是一个图形界面,可让您以用户友好的方式与 API 进行交互。
这些工具非常适合测试 GraphQL API,所以最终还是要看个人喜好。它们可以在 PC 上使用,但为了提高测试和工作效率,它们会有一些小改进。
API Tester 移动应用程序所有问题一个解决方案
在使用手机测试 API 的过程中,API Tester 移动应用应运而生。它将为您正在进行的工作提供轻松便捷且针对移动设备优化的体验。
它拥有您使用它们所需的所有工具。您可以使用其高级编辑器和 API 测试环境运行任何测试。
您的笔记本电脑不再是日常使用的必需品。您可以随时随地快速调试和测试您的 API。它支持 Graph Ql 测试环境以及所有有效的方法、get 和 post。
您可以将 API Tester 移动应用下载到您的 iPhone、iPad 或 Android 设备上。访问apitester.org或在 Play Store/App Store 中搜索“API Tester”,在第一个出现的应用上进行下载。
API 开发完成后,您是否想在移动应用上测试 GraphQL 查询?您可以在下面了解如何使用 API Tester 来实现这一点。
让我们了解如何使用 API Tester 在移动应用上测试您的 GraphQL 查询。
让我们使用 API 测试器应用
我将使用 GitHub API 来演示如何使用 API 测试器应用程序。它为我们提供实时数据。
点击右上角的“创建新请求”或 + 按钮即可启动 Graph QL 请求。
您可以在所附的屏幕截图中看到它。
您可以在“其他功能”下的新标签页中轻松找到 Graph QL 选项。点击它将带您进入更多选项。
在下一个屏幕上,您可以看到一个 GraphQL 无标题请求。
第一个选项卡显示请求名称。您可以重命名它(这是一个很好的做法,这样当有大量请求时您就不会感到困惑)。
此外,您需要提供 API URL 并将其粘贴到以 HTTPS 开头的部分。
您可以在下面看到 Graph QL 的多个选项,例如正文、变量、标题、文档和设置。
我将使用 GitHub API,因此我将将其放入api.github.com/graphql
URL 部分。
当您现在执行此操作时,您将看到此端点要求您进行身份验证,因此您需要提供身份验证信息并转到请求。
在 Headers 部分,您可以看到 OAuth 选项,因此您需要在此处提供访问令牌。您可以从 GitHub 生成它。我将使用我的令牌进行解释,并在相应的字段中提供它。
如何生成 GitHub API 令牌访问密钥。
要生成密钥,首先请访问github.com并使用您的凭据登录您的帐户,然后单击右上角的个人资料头像并选择“设置”。
在底部,你可以看到另一个名为“开发者设置”的选项。点击该选项,然后继续下一步。
这里有三个选项。选择“个人访问令牌”选项,然后点击“生成新令牌(经典)”。
在备注部分填写令牌名称以便记住。接下来选择令牌的有效期。
在进一步的选项中,选择用于 OAuth 访问目的的令牌范围,以及您想要允许访问或不想允许访问的内容。
完成这些设置后点击底部的按钮生成令牌。
恭喜,我们的令牌已生成!我们可以用它来进行应用中的 API 测试,以进行 Graph QL 测试。
让我们继续创建请求
我将按照上面指出的方式将创建的令牌粘贴到 OAuth 部分。
现在,我们必须转到“正文”部分并指定查询以获取特定类型的数据。例如,让我们获取 GitHub 帐户的 ID 信息。因此,使用 GitHub 登录名的相应查询写在正文选项卡中,如下面的屏幕截图所示。
如果您现在执行此操作,您将看到您获得了 GitHub 个人资料的登录名和 ID。
此外,如果您想获取 URL、个人简介或任何可用信息,您应该在正文部分将其作为查询提供。
在文档部分,您可以看到查询和变更。它们将帮助您如何执行显式请求。
测试技巧
现在您已经了解了在 Mobile API Tester 上测试 GraphQL 的基础知识,下面是一些需要牢记的提示:
-
首先,请确保您使用的是最新版本的 Graph QL 架构。如果不是,请更新您的架构并重新运行测试。
-
其次,检查你的解析器。确保它们能够正确解析你查询的数据。
-
第三,确保你的 Graph QL 服务器正在运行并且可以访问。你可以通过检查服务器日志来确认。
-
第四,如果您使用模拟的 Graph QL 服务器,请确保模拟数据正确。
-
创建测试时,请始终从最简单的查询开始,然后逐渐增加复杂性。这将帮助您更快地缩小问题范围。
-
注意查询的结构,确保其格式正确。这包括使用正确的大小写和缩进。
-
利用移动 API 测试器中的“调试”模式,精确查看每个请求发送的内容。这有助于进行故障排除。
-
为每种类型的测试(例如,单元测试和集成测试)创建单独的项目,使测试保持条理清晰。这样以后更容易找到所需的内容。
按照这些提示,您应该能够在 Mobile API Tester 上成功测试 GraphQL,而不会出现任何问题。
为什么选择 API Tester Mobile 应用程序?
API 测试器移动应用程序最适合在Android和iOS设备上进行 API 测试,因为:
-
它具有简单易用的界面,可以轻松测试您的 API。
-
该应用程序提供实时反馈,以便您可以了解 API 在实际使用中的表现。
-
它快速而高效,因此您可以快速测试多个 API。
API Tester Mobile 应用程序专门设计用于帮助开发人员测试他们的 API。
该应用程序提供了多种功能,可以轻松模拟真实用户与 API 的交互。
例如,您可以生成请求和响应、查看日志以及跟踪用户交互。该应用程序还具有内置调试器,可以轻松探索测试过程中的任何错误。
结论
在本文中,我们讨论了如何使用 API Tester Mobile 应用测试 GraphQL API。如果您正在使用 API,这是一个必备工具。它可以帮助您解决问题。该应用提供丰富的反馈,让您可以随时了解世界各地的请求和响应的进展情况。
如果你喜欢这篇文章,别忘了点赞❤️并收藏🏷️以便日后使用。如果你有任何问题或反馈,欢迎在下方评论区留言。下篇文章见。
与我联系
文章来源:https://dev.to/j471n/how-to-test-graphql-api-161i