[Epic] Native GraphQL Integration

[mohanarpit]

Objective

To introduce a native GraphQL Integration on the Appsmith platform

Requirements

1. Introduce a separate datasource called GraphQL that supports all the API authentication modes and parameters.
2. A user should be able to add the GraphQL Query language in the post body and execute it successfully
3. We should be able to support GraphQL variables out of the box
4. We should be able to support all settings except smart substitution i.e onPageLoad, confirm before execution, timeout, encode query params
5. PRD: https://www.notion.so/appsmith/PRD-Native-GraphQL-Support-Draft-8b67d6c768a04be0a65597ecf79c5cfd

Out of Scope

• GraphiQL Explorer
  • Provide GraphiQL's explorer like feature.
• GraphQL Specific Autocomplete
• GraphQL Subscriptions
• Query Caching
• Show variable value on hover in the evaluated value pane.
• Auto-generate variable definitions when a new variable is created in the query body.
• How to make pagination configuration easier
  • One idea we can explore is to auto generate the cursor path based on the cursor property name.

Research

1. JS Substitution inside query body with quotes / w/o quotes
2. JWT Authentication
3. Relay Pagination
4. GET vs POST HTTP Methods

RACI Matrix

| ------------- | ------------- |
| Responsible | @sumitsum , @AmanAgarwal041 , @prapullac, @parth-appsmith |
| Accountable | @sumitsum |
| Consulted | @Nikhil-Nandagopal, @mohanarpit, @ajinkyakulkarni |
| Informed | @nidhi-nair, @ayushpahwa |

Other Comments / Remarks

• From Confidence:

A small question on the Graphql integration
Why do we have the variables to the right VS having it at the bottom?
People may not necessarily need to use variables because we have the concept of binding. Wouldn't the space to the right be better used to display the gql schema and docs (which would actually be more valuable to users)?

[Johann-L-Pickard]

Hasura implements a cool version of GraphiQL which allows for easy query building and schema exploration. Being able to do this in the appsmith environment, and a way to save these queries and come back later and edit them in the same way would be great.

[rberger]

Being able to create front ends for AWS AppSync (GraphQL based) and mix with other data sources would be ultra-wonderful

[thebf]

This would pair nicely with Graphile.

[benjie]

The above query builder is actually GraphiQL Explorer from OneGraph; a lot of open source projects use it (because it's awesome): https://github.com/OneGraph/graphiql-explorer