什么是 apollo-errors?
apollo-errors 是一个用于 Apollo GraphQL 的错误处理工具。它提供了一种简单的方式来定义和呈现错误,以及自定义这些错误对应的 HTTP 状态码和错误消息。
安装
npm install apollo-errors
如何使用
首先,您需要创建一些错误类型。在 Apollo 中,错误类型是由 GraphQLError
和 GraphQLFormattedError
组成的。您可以使用 makeError
和 makeSingleError
函数来创建它们。
import { makeSingleError, makeError } from 'apollo-errors'; const NotFoundError = makeSingleError('NotFoundError', 'Resource not found', { code: 404 }); const ValidationError = makeError('ValidationError', 'Validation failed', { code: 400 }); export { NotFoundError, ValidationError };
在上面的示例中,我们创建了两个错误类型:NotFoundError
和 ValidationError
。这些错误类型都包含一个错误名称、错误消息和一个可选的状态码(默认为 500)。
然后,您需要为 Apollo 定义一些错误处理程序。您可以使用 formatError
函数来定义这些处理程序。
-- -------------------- ---- ------- ------ - ----------- - ---- ---------------- ----- ------------ - ------------------- -- - ----- - ------------- - - ------ -- -------------- ---------- ---------------- - ------ - -------- -------------- ----- ------------------------------ ----------------- ------------------------------- -- - ------ ------ --- ------ - ------------ --展开代码
在上面的示例中,我们的错误处理程序检查发生错误的类型并返回相应的错误消息和状态码。
最后,您需要为 Apollo 设置错误格式化程序。使用 ApolloServer
中的 formatError
选项即可。
-- -------------------- ---- ------- ------ - ------------ - ---- ---------------- ------ - ------------ - ---- ----------- ------ --------- ---- -------------- ------ ------ ---- ----------- ----- ------ - --- -------------- --------- ------- ---------- ------------ ------------- --- ----------------------- --- -- -- - --------------- ------ ----- -- --------- ---展开代码
总结
在本教程中,我们介绍了 apollo-errors
的一些基本概念和用例,希望能对您学习和使用 GraphQL 有所帮助。apollo-errors
提供了一种简单的方式来处理和自定义 GraphQL 中的错误,以便更好地服务于我们的应用程序。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/apollo-errors