This plugin provides a GraphiQL UI for exploring and testing the Vendure GraphQL APIs.
It adds routes /graphiql/admin and /graphiql/shop which serve the GraphiQL interface
for the respective APIs.
By default, the plugin automatically reads the Admin API and Shop API paths from your Vendure configuration.
If you need to override these paths, you can specify them explicitly:
You can add the following query parameters to the GraphiQL URL:
?query=... - Pre-populate the query editor with a GraphQL query.?embeddedMode=true - This renders the editor in embedded mode, which hides the header and
the API switcher. This is useful for embedding GraphiQL in other applications such as documentation.
In this mode, the editor also does not persist changes across reloads.Required<GraphiqlPluginOptions>(options: GraphiqlPluginOptions = {}) => Type<GraphiqlPlugin>(consumer: MiddlewareConsumer) => Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.