You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-9
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
GraphQL Query for JPA Entity Model
2
2
===============
3
+
3
4
This library uses [graphql-java v3.0](https://github.com/andimarek/graphql-java) to derive and build the GraphQL schema from JPA Entity Schema provided by entity classes.
4
5
5
6
It implements a schema builder to generate GraphQL Schema using JPA EntityManager with JPA Query Data Fetchers that transform GraphQL queries into JPA queries with flexible type safe criteria expressions and user-friendly SQL query syntax semantics i.e. query by page, , where criteria expressions, select, order by etc.
@@ -9,14 +10,48 @@ Modules
9
10
The GraphQL-JPA-Query library consists of the following modules:
10
11
11
12
1.`graphql-jpa-query-annotations` - Provides annotations for instrumenting your entity models with GraphQL Schema Descriptions
12
-
2.`graphql-jpa-query-schema` - Provides interface specifications and implementation of the JPA schema builder and JPA data fetchers
13
+
2.`graphql-jpa-query-schema` - Provides interface specifications and implementation of the JPA Schema Builder and JPA Data Fetchers
13
14
3.`graphql-jpa-query-boot-starter`- Provides Spring Boot auto-configuration support to enable GraphQL JPA Query in your project
14
15
4.`graphql-jpa-query-example` - Provides example application for Books entity models
15
16
16
-
Dependencies
17
+
Building with jitpack.io [](https://jitpack.io/#introproventures/graphql-jpa-query)
18
+
------------------------
19
+
You can simply use jitpack.io to include and build individual modules in your project. You will need to add jitpack.io repository in our project to resolve required artifacts using valid release tag.
The library tries to keep the following dependencies: graphql-java, and some javax Jpa 2.1 packages. The tests depend
19
-
on Spring Boot with Hibernate for JPA.
54
+
The core library module `graphql-jpa-query-schema` keeps dependencies to a minimum. The main dependecies for schema module are `graphql-java`, `evo-inflector`, `javax.transaction-api`, `hibernate-jpa-2.1-api`. The tests depend on Spring Boot 1.5 with Web and Hibernate for JPA starters.
20
55
21
56
Schema Generation
22
57
-----------------
@@ -242,14 +277,14 @@ Performance
242
277
-----------
243
278
The JPA DataFetcher implementation will attempt to build dynamic fetch graph in order to optimize query performance and avoid N+1 lazy loading.
244
279
245
-
GraphiQL Browser
280
+
Examples
246
281
--------
247
282
248
-
GraphiQL (https://github.com/graphql/graphiql) can be used for simple testing. You can launch provided example as Spring Boot Application, and navigate to http://localhost:8080/ to load GraphiQL browser. The collapsed Docs panel can opened by clicking on the button in the upper right corner, that when expanded will show you the running test schema.
283
+
GraphiQL (https://github.com/graphql/graphiql) can be used for simple testing. You can build and launch provided example as a Spring Boot Application, then navigate to http://localhost:8080/ to load GraphiQL browser. The collapsed Docs panel can opened by clicking on the button in the upper right corner to expose current test schema models.
249
284
250
-
You can run GraphQL queries in the left pannel, and hit the run button, and the results should come back in the right
251
-
panel. If your query has variables, there is a minimized panel at the bottom left. Simply click on this to expand, and
252
-
type in your variables as a JSON string (don't forget to quote the keys!).
285
+
You can run GraphQL queries in the left pannel. Type the query and hit the run button. The results should come up in the middle
286
+
panel. If your query has variables, there is a minimized panel at the bottom left. Simply click on this to expand, and
287
+
type in your variables as a JSON string with quoted keys.
0 commit comments