https://github.com/graph-quilt/graphql-xtext
A GraphQL SDL lexer, parser, and validator that can read GraphQL grammar and produce executable JVM runtime objects.
https://github.com/graph-quilt/graphql-xtext
grammars graphql graphql-java graphql-sdl java schema-validation xtext
Last synced: 2 months ago
JSON representation
A GraphQL SDL lexer, parser, and validator that can read GraphQL grammar and produce executable JVM runtime objects.
- Host: GitHub
- URL: https://github.com/graph-quilt/graphql-xtext
- Owner: graph-quilt
- License: other
- Created: 2019-11-25T18:33:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T09:26:13.000Z (over 1 year ago)
- Last Synced: 2025-03-28T22:07:20.197Z (3 months ago)
- Topics: grammars, graphql, graphql-java, graphql-sdl, java, schema-validation, xtext
- Language: Xtend
- Size: 1.61 MB
- Stars: 22
- Watchers: 11
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# GraphQL-Xtext
[](https://circleci.com/gh/graph-quilt/graphql-xtext/tree/master)
A GraphQL SDL lexer, parser, and validator that generates a traversable Abstract Syntax Tree from your GraphQL schema. GraphQL-Xtext will generate pure Java Objects that can be used at runtime.
The EMF objects can be used to implement Apollo Federation Spec and build a purely java based service that is truly open source.
## Installing the Software
This project uses `java 8` and `maven 3.3+`.
1. Download and install [Eclipse 2019](https://www.eclipse.org/downloads/).
2. Install Xtext SDK in Eclipse:
a. In Eclipse, click `Help --> Install New Software`
b. In Available Software, click Add to add a repository with location:
```http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/```
c. Select and install Xtext Complete SDK (2.19.0)
3. Restart Eclipse.
## Setting up the Project
1. Clone [graphql-xtext](https://github.com/graph-quilt/graphql-xtext)
2. Import the cloned project in Eclipse, click `File --> Import Project --> Maven --> Existing Maven Project`
3. Under the directory `com.intuit.graphql`,
right click on `GenerateGraphQL.mwe2 --> Run As --> 1 MWE2 Workflow`
## Testing the grammar in an IDE
Right-click on the `com.intuit.graphql.ide` directory and Run As `Eclipse Application`
## Building the project
```
mvn clean install
```
## Language Server Support
Graphql-Xtext builds a Language Server executable under `com.intuit.graphql.parent/com.intuit.graphql.ide/target/`, named
`com.intuit.graphql.ide-x.y.z-ls.jar`. This can be used to build generic application and cloud-based IDEs for the grammar.
[`theia-xtext`](https://github.com/theia-ide/theia-xtext) is an example of a cloud-based IDE that uses the xtext language server jar.
## License
[Apache 2.0](./LICENSE)
## Contributing
Read the [Contribution guide](./.github/CONTRIBUTING.md)