SmallRye GraphQL

SmallRye GraphQL is an implementation of

• Eclipse MicroProfile GraphQL.

• GraphQL over HTTP.

• GraphQL over WebSocket.

• Subscriptions transport ws (old).

• GraphQL Federation

Instructions

Testing against the released v 2.0 of MicroProfile GraphQL

mvn clean install

Note that some tests perform locale-sensitive assertions. If you use non-English locale, you need to adjust the command above. For example: LANG=C mvn clean install

Testing against the unreleased v 2.1-SNAPSHOT of MicroProfile GraphQL

(You need to build that version of MicroProfile GraphQL locally first to make the snapshot versions available in your repository)

mvn clean install -Dversion.eclipse.microprofile.graphql=2.1-SNAPSHOT

Documentation

The live documentation is available at this link.

Info about how to build and manage the documentation is in docs/README.adoc.

Javax/Jakarta

The 1.5.x branch will be maintained for the javax namespace, and the main (2.x) branch for jakarta.

Project structure

Common

• Schema Model (Serializable) that defines the schema.

• Schema Builder that create the model from Jandex.

Server

• API (pulling in the MicroProfile API) and allowing us to experiment with api feature not yet in the spec. Code from here might move the the spec at some point.

• Implementation of the Eclipse MicroProfile GraphQL API.

• CDI Module that allows lookup of GraphQL Endpoints via CDI.

• Servlet Making the implementation available via Servlet.

• TCK Test suite to run the implementation against the Eclipse MicroProfile GraphQL TCK.

• Runner Manual TCK testing with GraphiQL.

• IT To run some Integration tests.

Client

• Client API (pulling in the MicroProfile Client API) and allowing us to experiment with API feature not yet in the spec. Code from here might move the spec at some point.

• Client Implementation of the Eclipse MicroProfile GraphQL Client API.

• Client TCK Test suite to run the client-implementation against the Eclipse MicroProfile GraphQL Client TCK.

• Client Implementation Vert.x Module for Vert.x handling for the client.

• Client Generator Module generating Type-Safe Client APIs with annotation processing.

• Client Generator Test Module containing tests for client generators.

• Client Model defines Type-Safe’s client model (GraphQL operations).

• Client Model Builder that generates Client Model from Jandex.

Tools

• Maven plugin that generates the GraphQL schema from source files.

• Gradle plugin that generates the GraphQL schema from source files.

UI

• GraphiQL UI for your project

Documentation

• Documentation SmallRye GraphQL documentation source

Links

• Project Homepage

• Eclipse MicroProfile GraphQL

• SmallRye GraphQL Documentation