Skip to content

Commit a35b0c8

Browse files
author
IntroPro Ventures
authored
Update README.md
1 parent 4310729 commit a35b0c8

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,18 @@ This library uses [graphql-java v3.0](https://github.com/andimarek/graphql-java)
44

55
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.
66

7+
Modules
8+
-------
9+
The GraphQL-JPA-Query library consists of the following modules:
10+
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
15+
716
Dependencies
817
-----------------
9-
This library intends to have 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 annotation packages. The tests depend
1019
on Spring Boot with Hibernate for JPA.
1120

1221
Schema Generation
@@ -16,7 +25,7 @@ The models are introspected using a JPA Entity Manager to auto-generate a GraphQ
1625
Schema Documentation
1726
--------------------
1827
GraphQL provides a well documented schema for your domain entity model. The Schema Builder produces
19-
descriptions using `@GraphQLDescription` annotation on Java types and fields. These descriptions will show up in the GraphiQL schema browser to help you provide documented API to end-users. See the GraphiQL section below for more details.
28+
descriptions using `@GraphQLDescription` annotation on Java types and fields. These descriptions will show up in the GraphiQL schema browser to help you provide documented API to end-users. See the GraphiQL section below for more details. You can use `@GraphQLIgnore` annotation to exclude entity type or field from schema.
2029

2130
Queries
2231
--------------

0 commit comments

Comments
 (0)