content-type aware response handler plugins

[acao]

This seems like the easiest to start with, defaulting to just the JSON handler of course.

This would satisfy at least 4 open feature requests if not many more.

const jsonResponsePlugin = {
  label: "JSON",
  parser: (dataString) => JSON.parse(dataString),
  editorOptions: {
    language: 'json'
  },
  previewComponent: ({ data }) =>
	  <JSONGraph data={data} />
}

const json5ResponsePlugin = {
  label: "JSON5",
  parser: (dataString) => JSON5.parse(dataString),
  editorOptions: {
    language: 'json5'
  },
  previewComponent: ({ data }) => <JSONGraph data={data} />
}

<GraphiQL
  httpResponsePlugins={{
    'application/json': jsonResponsePlugin,
    'text/json': jsonResponsePlugin,
    'application/json5': json5ResponsePlugin,
  }}
/>

Advanced Example

We're going to be able to do some amazing stuff with this 😻 .

export const plugin = {
  label: "Markdown",
  parser: (dataString) => {
    const file = greymatter(dataString);
    // operationName, errors, etc
    return { ...file.data, data: file.content };
  },
  editorOptions: {
    language: "markdown",
  },
  previewComponent: ({ dataString, data }) => (
    <>
      <article>
        <h2>{data.title}</h2>
        <div>{md.render(dataString)}</div>
      </article>
      <aside>
        Written by: <Avatar author={data.author} />
      </aside>
    </>
  ),
};

Subscriptions GUI?

How would this impact the subscriptions GUI? it would be used to define how each iteration is formatted depending on the response content type

Other Response types

So many have been requested ! None of these are spec of course, but the demand to experiment here has been persistent across many use cases

• Yaml
• Protobufs
• Messagepack
• HTML
• HJSON
• ?

Past Feature Requests

• Feature request: JSON5 Variables #780
• Plugin: ResultViewer YAML renderer #702

[thomasheyenbrock]

This would satisfy at least 4 open feature requests if not many more.

Can we find and link these issues with this discussion thread? I'm missing a proper description of the problem space here, this discussion jumps right into solution space. Without that I'm not feeling confident contributing or commenting on this.

[acao]

They are the same issues on the github projects beta roadmap I shared with in the winter. Linked above!

[thomasheyenbrock]

Thank you ❤️