Skip to content

Commit 6ccfe60

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents e4e7e90 + 95d8a6d commit 6ccfe60

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@ GraphQL Query for JPA Entity Model
22
===============
33
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.
44

5-
It implements a schema builder to generate GraphQL Schema using JPA EntityManager and an JPA Data Fetchers to 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.
5+
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.
66

77
Modules
88
-------
99
The GraphQL-JPA-Query library consists of the following modules:
1010

11-
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-
3. GraphQL JPA Query Web - Provides web interface endpoint for executing queries via HTTP
14-
4. GraphQL JPA Query Spring Boot Starter - Provides Spring Boot auto-configuration support to enable GraphQL JPA Query in your project
11+
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+
3. `graphql-jpa-query-boot-starter`- Provides Spring Boot auto-configuration support to enable GraphQL JPA Query in your project
14+
4. `graphql-jpa-query-example` - Provides example application for Books entity models
1515

1616
Dependencies
1717
-----------------
18-
The library tries to keep the following dependencies: graphql-java, and some javax annotation packages. The tests depend
18+
The library tries to keep the following dependencies: graphql-java, and some javax Jpa 2.1 packages. The tests depend
1919
on Spring Boot with Hibernate for JPA.
2020

2121
Schema Generation
2222
-----------------
23-
The models are introspected using a JPA Entity Manager to auto-generate a GraphQL Schema. After that, you can use GraphQL schema to query your data.
23+
The models are introspected using a JPA Entity Manager to auto-generate a GraphQL Schema. After that, you can use GraphQL schema to execute GraphQL query against your data.
2424

2525
Schema Documentation
2626
--------------------
@@ -29,11 +29,10 @@ descriptions using `@GraphQLDescription` annotation on Java types and fields. Th
2929

3030
Queries
3131
--------------
32-
This library will wrap each entity into two query fields:
33-
Each model (say Human or Droid - see tests) will have two representations in the generated schema:
32+
This library will wrap each entity into two query fields for each entity model (say Human or Droid - see tests) will have two representations in the generated schema:
3433

35-
- One that models the Entities directly using singular form, i.e. Human or Droid to get single instance by id.
36-
- One that wraps the Entity in a pagable request with where criteria expression using Entity pluralized form, i.e. Humans or Droids
34+
- One that models the Entity directly using singular form, i.e. Human or Droid to get single instance by id.
35+
- One that wraps the Entity in a pagable query request with where criteria expression using Entity pluralized form, i.e. Humans or Droids
3736

3837
Singular Query Wrapper
3938
--------------

0 commit comments

Comments
 (0)