Add section on GraphiQL to the documentation including advice on customizations

[m4st3rm4tz3]

The links for the external libraries inside GraphiQLs index.html are hardcoded and point to unpkg.com. Because of this it is currently not possible to host an api with /graphiql enpoint in an offline environment.

It would be great if GraphiQL offline support could be added! Maybe by putting the needed libraries inside the resources folder too, like the graphql-java-kickstart/graphql-spring-boot project.

Or is there currently a known workaround for this problem?

[bclozel]

This is something we considered more broadly in #20 and #204 (comment).

Shipping 3rd party libraries with our own spring-graphql JAR will tie our release cycle with those and can become a liability. What happens if a new major/minor version of the library is released, should we upgrade as soon as possible, possibly breaking custom integrations written by developers? What happens if the 3rd party library has a CVE - in this case, we'd have a CVE of our own as well and we'd need to ship a new version of Spring for GraphQL.

This also opens the door for many customizations, plugins, possibly a build that's more involved to produce custom versions of those libraries built from sources, things that graphql-java-kickstart invested in.

In my opinion, our time and energy would be better spent documenting how to build and integrate your own GraphiQL instance with Spring for GraphQL: this would not only cover your use case, but also give you more freedom to customize things more. Would this approach help?

[m4st3rm4tz3]

Oh, I didn't see that issue. Sorry! I totally get the downsides of shipping the external libraries with the spring-graphql jar, but your suggested approach would be perfectly fine and help me a lot!

So the approach would be something similar to hosting my own static graphiql template on a /graphiql endpoint next to my graphql api with my spring boot app?

[bclozel]

No worries! This one is a bit different but we can tackle a bunch of related use cases like this.
I think we should document a simple build setup and show how to ship your own. In the process, we should ensure that the Spring Boot auto-configuration allows this.

[LexanRed]

Is there any documentation available yet? I was just running into this issue.
Offline development which requires graphiql is made hard.

I helped myself by using Altair as a standalone client, but having graphiql built in in a way which works offline would be great for us.

[talniv18]

Hello, is there any progress with this issue? we also use graphql in offline environment, and although we use Postman as our client, it will be much better to make the graphiql work.