GraphQL API 是一种用于构建灵活且高效的 API 的技术。在使用 GraphQL API 时，测试中经常会出现一些错误。如果没有给出明确的错误消息，可能会导致开发人员难以识别错误和 debug。本文将会详细地介绍如何为 GraphQL API 提供测试时的错误消息。
什么是 GraphQL API？
GraphQL API 是一种 API 构建技术，它允许客户端指定哪些数据应该从服务器请求，以及返回的数据的形式。与传统的 REST API 相比，GraphQL API 具有以下优势：
- 可以灵活地定义返回的数据
- 可以节省网络带宽
- 对于语义方面的查询也可以灵活处理
为什么需要提供错误消息？
在测试 GraphQL API 时，开发人员需要了解错误发生的位置及原因。如果不提供错误消息，开发人员就需要自己分析错误的位置，这可能会导致测试的不确定性和工作的繁琐。
如何为 GraphQL API 提供错误消息？
下面是一些提供 GraphQL API 错误消息的方法：
1. 返回错误码
在错误发生时，可以返回一个错误码，并提供有关错误的说明。客户端可以使用错误码来识别错误位置并进行 debug。例如，以下是返回错误码的示例代码：
-- -------------------- ---- -------
-
--------- -
-
---------- --------------
------------- -
------- ----------------
-
-
-
-在此示例中，错误消息是 请提供有效的查询参数。，错误码是 BAD_USER_INPUT。
2. 返回详细的错误信息
在错误发生时，可以返回一个详细的错误信息。客户端可以使用这个详细的错误信息来快速识别错误并进行 debug。例如，以下是返回详细错误消息的示例代码：
-- -------------------- ---- -------
-
--------- -
-
---------- --------------
------------ -
-
------- --
--------- -
-
--
------- -
-------
------
--
------------- -
------- ----------------
-
-
-
-在此示例中，除了错误消息之外，还返回了有关错误的位置和原因的信息。locations 表示发生错误的行和列，path 表示错误所在的路径。
3. 返回友好的错误信息
在错误发生时，可以返回一个友好的错误消息，这样开发人员就可以轻松理解错误的位置和原因。例如，以下是返回友好错误消息的示例代码：
-- -------------------- ---- -------
-
--------- -
-
---------- -------- - -------
------------- -
------- ----------------
-
-
-
-在此示例中，错误消息是 无效的查询参数 : 用户姓名。 ，给出了更具体的错误原因。
结论
GraphQL API 是一种强大的 API 构建技术。在测试 GraphQL API 时，提供错误消息可以帮助开发人员快速和准确地 debug。在本文中，我们介绍了一些提供错误消息的方法，包括返回错误码、返回详细的错误信息和返回友好的错误信息。希望本文可以帮助您更好地了解如何为 GraphQL API 提供测试时的错误消息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/674aef0cda05147dd02b80a7