Skip to content

Commit 8da7838

Browse files
committed
Updating readme
1 parent fa402f0 commit 8da7838

File tree

1 file changed

+6
-30
lines changed

1 file changed

+6
-30
lines changed

README.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,22 @@
11
# graphql-orchestrator-java
22

3+
[Builds](https://circleci.com/gh/intuit/graphql-orchestrator-java)
4+
35
### Overview
46

57
**GraphQL Orchestrator** is a library that exposes data from various data providers using a single unified GraphQL schema.
68
It aggregates and combines the schemas from these data providers and orchestrates the graphql queries to the appropriate services.
9+
10+
711
It uses the [graphql-java](https://github.com/graphql-java/graphql-java) library as the runtime execution engine on the unified schema.
812

913
### Getting Started
1014

11-
Requirement:
12-
* Java 8
13-
* Maven 3
14-
15-
1. Add this library to your project
16-
```
17-
<dependency>
18-
<groupId>com.intuit.graphql</groupId>
19-
<artifactId>graphql-orchestrator-java</artifactId>
20-
<version>${version}</version>
21-
</dependency>
22-
23-
2. Implement the [ServiceProvider](https://github.intuit.com/data-orchestration/stitching/blob/master/src/main/java/com/intuit/graphql/stitching/ServiceProvider.java) interface for the services you want to stitch.
24-
25-
3. Use the library in your code. Example:
26-
```
27-
// Build the stitcher with multiple services. Service interface in progress
28-
final GraphQLOrchestrator orchestrator = GraphQLOrchestrator.newOrchestrator()
29-
.instrumentations(Collections.emptyList())
30-
.services(Collections.emptyList()) // Implemented in Step 2
31-
.executionIdProvider(ExecutionIdProvider.DEFAULT_EXECUTION_ID_PROVIDER)
32-
.queryExecutionStrategy(new AsyncExecutionStrategy())
33-
.mutationExecutionStrategy(new AsyncExecutionStrategy())
34-
.build();
35-
36-
//execute the request
37-
orchestrator.execute(executionInput);
38-
39-
```
15+
Please take a look at [this example](https://intuit.github.io/graphql-orchestrator-java/usage/getting_started/)
4016

4117
### Documentation
4218

43-
Coming soon...
19+
Detailed [Documentation](https://intuit.github.io/graphql-orchestrator-java/) can be found here
4420

4521
### Contributing
4622

0 commit comments

Comments
 (0)