graphql / graphql/graphiql

Proposal: GraphQL editor deeplinking standard

Open
#1,484 7 comments 14 reactions 0 assignees View on GitHub
graphiql potential plugin
Dominant language
TypeScript
Stars
16.9k
Forks
1.9k
Avg merge
22h 45m
Merged PRs (30d)
70

Description

GraphQL has wide editor support, and projects like GraphiQL and GraphQL Playground have ensured that there is a proliferation of different web editor instances.

An invariable feature that we have already seen rolled out on an adhoc basis (e.g. https://www.onegraph.com/graphiql) is the ability to generate a link within a graphql editor that allows easy sharing of queries between users.

Such links are also useful from a documentation perspective, in that they allow users to easily open, edit, and run queries referenced in the documentation by simply clicking a link, improving the user experience.

A standardized format for these links would be a boon not only to online editors, but also IDEs, in that a given IDE would be able to register an app uri handler for GraphQL, making it very easy to implement features such as "open in local ide".

The format would not necessarily be restricted to just queries, it could also be potentially useful for service discovery, perhaps referencing an introspection endpoint, or schema SDL.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.