Graphiql: Permalinks (share URL link)?

[borekb]

According to #7, queries in URL are a feature of GraphiQL and I've seen them in the wild, for example, in the Pokemon API. But I've also encountered several GraphiQL installations that don't have queries in URLs, e.g., Shopify's, MongoDB todo list, etc.

In https://github.com/graphql/graphiql/issues/703, it is mentioned that it's supported via graphiql-rails but is that the only way?

I'm just asking for clarification. On the APIs that support the ?query= URL links, I find it a bit suspicious that it's ? and not # (I'd imagine queries working purely client-side).

[benjie]

Hi @borekb, yes you can do this with GraphiQL. This example shows you how:

https://github.com/graphql/graphiql/blob/master/packages/graphiql-examples/cdn/index.html#L48-L55 https://github.com/graphql/graphiql/blob/2ea30c6029fd47107e85fb9d86459b02792ec705/packages/graphiql-examples/cdn/index.html#L48-L55

(The location of this example file moved when we turned this repo into a monorepo.)

Hope this helps!

(I'm assuming that the ?query= enables server-side rendering of GraphiQL, but I may be wrong on that.)

[borekb]

Thanks, @benjie!

[gilesbradshaw]

@benjie that link 404's dunno if you could possibly edit?

[acao]

@gilesbradshaw we moved the examples around.

You’ll find an example of how to do this in packages/graphiql/resources/renderGraphiQL.js

[benjie]

I've updated my comment above to a link equivalent to what was there before (but permanent). Rikki's example is better; but it has also moved; it's now (permalink) here:

https://github.com/graphql/graphiql/blob/bcb27538d9074afdac3ff56074046965b456e57a/packages/graphiql/resources/renderExample.js