Skip to content

GraphiQL UI usage

Jump to bottom
Jan Martiska edited this page Mar 3, 2021 · 1 revision

GraphiQL usage

To add a GraphiQL UI to your application, add this to your pom.xml:

<dependency>
    <groupId>io.smallrye</groupId>
    <artifactId>smallrye-graphql-ui-graphiql</artifactId>
    <!-- preferably use the same version as is included in the GraphQL feature pack -->
    <scope>compile</scope> 
</dependency>

The deployment processor will detect the presence of the graphiql (by detecting that your WAR includes a JAR that contains a file named META-INF/resources/graphql-ui/render.js) and will make sure that the UI is available under <context-root-of-your-app>/graphql-ui

Clone this wiki locally