Page MenuHomePhabricator

📚 Investigate GraphQL "explorers"
Closed, ResolvedPublic

Description

Which tools exist, what features do they have?
Known tools:

What are pros and cons of embedding on a special page vs self-hosting on a dedicated page vs using an existing externally hosted explorer?

Related Objects

Event Timeline

Embedded GraphQL explorers
Looks like GraphiQL is the only viable option after all. The embedded Apollo Explorer renders an iframe to their web app (see docs), which is not something we want. All other alternatives don't seem worth considering.

Third party GraphQL client webapps
Apollo Sandbox seems to be the most polished one that supports all the features that we want:

https://web.altairgraphql.dev/ looks nice too, but doesn't support sharing queries via URL.

Embedding on a special page vs a separate GraphiQL page vs third party site
Embedding GraphiQL on a special page:

Separate GraphiQL page:

  • could be hosted on doc.wikimedia.org like the REST API docs
  • similar pros and cons to the "Embedding GraphiQL on a special page" option, without the horizontal space constraints, but with the downside of not being on the wiki itself
  • looks like this: https://graphql.org/swapi-graphql/

Third party webapps:

  • Apollo Sandbox seems to be the only option
  • no development or maintenance effort
  • downsides
    • takes users away from the on-wiki docs (opening those "try it out" links in a new tab would help a little)
    • we have no control over the external site. Apollo has a decent reputation now, sending users to a broken page, or one with content we don't want to be associated with would not be great.

I'd prefer sticking to GraphiQL on the special page then, cc: @ECohen_WMDE

To make it absolutely clear, the main reason for choosing that is not the one time error but the fact that it cannot be embedded. I would prefer not sending users to a third party site

Screenshot from 2026-02-09 11-38-30.png (540×437 px, 58 KB)