Proposal: Default headers for GraphQLPlayground.init

I’m building a Ruby on Rails integration for GraphQL Playground - here.

In a lot of Ruby on Rails application, developers use the GraphQL with the build in CSRF protection.

For the gem to work, I have to be able to set default headers for the GraphQL endpoint. I imagining the following would do the trick:

window.addEventListener('load', function (event) {
  GraphQLPlayground.init(document.getElementById('root'), {
    endpoint: '<%= graphql_endpoint_path %>',
    headers: {
      'X-CSRF-Token': '<%= form_authenticity_token %>',
    },
  });
});
 

This would also be useful, for default authentication headers and similar.

[robertopedroso]

Seconding this – I was working on a PR to add graphql-playground as an optional interface to graphene-django, but the inability to set headers through the playground’s init function makes this impossible.

The <Playground /> component accepts headers as an optional prop. I’m pretty sure the prop would simply have to be added to <PlaygroundWrapper /> and <GraphQLBinApp />.

I lack React expertise, but if someone can confirm my thoughts on passing this prop down, I’d be happy to make a PR.

[huv1k]

Thanks to @wilsongp its done in #825 and will be released in the new version of the playground.