Integrating the library

This is the documentation of the GraphQL Library version 7. For the long-term support (LTS) version 5, refer to GraphQL Library version 5 LTS.

Interaction

In GraphQL and Aura Console as well as Self-hosting GraphQL, a GraphQL server serves the GraphQL schema, so you can interact directly with your API with no frontend. In case you prefer to use frontend frameworks, these are some clients that interact with GraphQL APIs:

Deployment

There are a variety of methods for deploying GraphQL APIs.

With Aura Console, you can create and use a GraphQL API, see GraphQL and Aura Console.

The Self-hosting GraphQL guide uses Apollo Server. You can check the Apollo documentation on Deployment for more details.

Requirements

The Neo4j GraphQL Library requires one of the following Neo4j database versions:

  1. Neo4j AuraDB version 2025.x

  2. Neo4j Database running only the latest 5.x or 2025.x versions

The APOC core plugin must be installed.

To check whether the requirements are met before starting the server, the checkNeo4jCompat function is exposed on the Neo4jGraphQL instance.