GraphQLでエラーが起きた時のエラーの返り方について私の認識が合っているかお聞きしたいです。
基本的にqueryで失敗した際のレスポンスとしてはerrorsというフィールドでエラー内容が返ってくる、mutationの場合はuserErrorsというフィールドでエラーが返ってくるという認識です。
また、クエリが失敗する原因として以下に挙げる以外で他に例がありましたら教えてください
-
ネットワークエラー
-
クエリの記述ミス
-
クエリコスト
Topic summary
GraphQLにおけるエラーハンドリングの方法について、質問者の認識確認を求める投稿。
質問者の認識:
- queryの失敗時は
errorsフィールドでエラーが返される - mutationの失敗時は
userErrorsフィールドでエラーが返される
回答:
認識は正しいと確認された。Shopify公式ドキュメント（https://shopify.dev/docs/api/admin-graphql#status_and_error_codes）にも記載がある。
エラーの種類（例）:
- アクセス権限がない場合（例：customers_read権限なしでpaymentMethodsを取得しようとした場合）
- Shopify内部的なエラー
ドキュメントにはエラーコードの詳細も記載されている。質問者は他のクエリ失敗原因の例も求めている。
基本的にqueryで失敗した際のレスポンスとしてはerrorsというフィールドでエラー内容が返ってくる、mutationの場合はuserErrorsというフィールドでエラーが返ってくるという認識です。
認識合っていると思います。
https://shopify.dev/docs/api/admin-graphql#status_and_error_codes にも記載があります。
The response for the errors object contains additional detail to help you debug your operation.
The response for mutations contains additional detail to help debug your query. To access this, you must request userErrors.
また、クエリが失敗する原因として以下に挙げる以外で他に例がありましたら教えてください
上記URLのページ内にエラーコードの記述があります。
・アクセス権限がない (たとえばread_customers権限がないときに、paymentMethodsを取得しようとしたときなど)
・Shopifyの内部的なエラー
などのエラーも返ってきます。