Skip to main content
Version: 1.31.1

Introduction to the GraphQL API

The Platformatic DB GraphQL plugin starts a GraphQL server wand makes it available via a /graphql endpoint. This endpoint is automatically ready to run queries and mutations against your entities. This functionality is powered by Mercurius.

GraphiQL

The GraphiQL web UI is integrated into Platformatic DB. To enable it you can pass an option to the sql-graphql plugin:

app.register(graphqlPlugin, { graphiql: true })

The GraphiQL interface is made available under the /graphiql path.