We’re overhauling Dgraph’s docs to make them clearer and more approachable. If you notice any issues during this transition or have suggestions, please let us know.

When you deploy a GraphQL schema, Dgraph serves the corresponding spec-compliant GraphQL API at the HTTP endpoint /graphql. GraphQL requests can be sent via HTTP POST or HTTP GET requests.

​
Getting your GraphQL endpoint

  • access the Overview panel of Dgraph Cloud dashboard.
  • the GraphQL Endpoint is displayed at the bottom.
  • click on the link button to copy it.

​
IDEs

As Dgraph serves a spec-compliant GraphQL API, you can use your favorite GraphQL IDE.

  • Postman
  • Insomnia
  • GraphiQL
  • VSCode with GraphQL extensions

​
General IDE setup

  • Copy Dgraph GraphQL endpoint.
  • Set the security header as required.
  • use IDE instrospection capability.

​
Clients

You are ready to write GraphQL queries and mutation and to run them against Dgraph cluster.

When building an app in React, Vue, Svelte, or any of you favorite framework, using a GraphQL client library is a must.

As Dgraph serves a spec-compliant GraphQL API from your schema, supports instropection and GraphQL subscriptions, the integration with GraphQL UI client libraries is seamless.

Here is a not limited list of popular GraphQL UI clients that you can use with Dgraph to build apps:

Was this page helpful?

Suggest edits
QuickstartAPI Endpoints