Build a GraphQL API with SmallRye GraphQL¶
The graphql module exposes a GraphQL API with SmallRye GraphQL. It
demonstrates queries, a mutation, a computed field, and a subscription. Its
posts store is in memory and does not persist data to a database.
Start the server¶
From the graphql directory, run:
./mvnw quarkus:dev
On Windows, run mvnw.cmd quarkus:dev. The GraphQL endpoint is
http://localhost:8080/graphql.
Inspect the API¶
The module uses quarkus-smallrye-graphql. Its
GraphQLResource
declares:
allPostsandpostByIdqueries.- A
createPostmutation. - A
countOfCommentsfield resolver that reads the sourcePost. - A
postCreatedsubscription that returns a MutinyMulti.
The PostService stores posts in an in-memory list and publishes creation
events through a broadcast processor.
Validate inputs and handle errors¶
createPost accepts a @Valid CreatePost input, so the input object's
Jakarta Bean Validation constraints are applied to mutations. The sample
defines PostNotFoundException with the SmallRye @ErrorCode annotation and
configures GraphQL error extension fields in
application.properties.
This demonstrates returning a machine-readable error code and exposing
selected error details; review the sample's settings before exposing
exception messages in a public API.
Send a query¶
Send a GraphQL request to the endpoint. In PowerShell, run:
curl.exe -X POST http://localhost:8080/graphql `
-H "Content-Type: application/json" `
--data-raw '{"query":"{ allPosts { id title content countOfComments } }"}'
The response contains the selected fields under data.allPosts.
Exercise the server from a test¶
The module ships a @QuarkusTest (GraphQLResourceDynamicClientTest) that calls the running
application through SmallRye's dynamic client API (DynamicGraphQLClient, added in test scope via
quarkus-smallrye-graphql-client). Injecting the client with an empty @GraphQLClient("") config key
makes Quarkus point it at the application's own /graphql endpoint automatically, so no url has to be
configured. The test asserts on real results: the seeded allPosts, a postById lookup passed as a
postId argument, and a createPost mutation whose input is sent as a CreatePostInput variable.
What's next¶
- See the typesafe client, dynamic client, Java HTTP client, and JAX-RS client.
- Return to the GraphQL part index.