スキーマの設定
スキーマの設定GraphQLレスポンスへのカスタムヘッダーの追加(CORS)

GraphQLレスポンスへのカスタムヘッダーの追加(CORS)

GraphQLレスポンスにカスタムヘッダーを追加できます。特に、CORSの問題を回避するために Access-Control-Allow-Origin ヘッダーを設定する際に役立ちます。

レスポンスヘッダーはSchema Configurationを通じて設定され、エンドポイントごとに異なるヘッダーを送信できます。たとえば、各エンドポイントが使用を想定する特定のドメインを Access-Control-Allow-Origin ヘッダーで送信することで、APIのセキュリティを高めることができます。

レスポンスヘッダーの定義

レスポンスヘッダーは2か所で設定できます。

エンドポイントに適用されたSchema Configurationの「Response Headers」ブロックで、"Use custom configuration" オプションを選択し、希望のヘッダーを(1行に1エントリの形式で){header name}: {header value} の形式で指定します。

たとえば、次の値を指定します:

Access-Control-Allow-Origin: https://mysite.com
Access-Control-Allow-Headers: content-type,content-length,accept
Schema ConfigurationでResponse Headersを指定する
Schema ConfigurationでResponse Headersを指定する

それ以外の場合は、設定ページの Response Headers で定義された値が使用されます:

設定でResponse Headersを指定する
設定でResponse Headersを指定する