2015-09-12 12:54:05 +02:00
|
|
|
|
# Haskell GraphQL
|
|
|
|
|
|
|
|
|
|
[![Hackage Version](https://img.shields.io/hackage/v/graphql.svg)](https://hackage.haskell.org/package/graphql)
|
2020-06-24 09:45:25 +02:00
|
|
|
|
[![Build Status](https://github.com/caraus-ecms/graphql/workflows/Haskell%20CI/badge.svg)](https://github.com/caraus-ecms/graphql/actions?query=workflow%3A%22Haskell+CI%22)
|
2019-07-06 07:57:18 +02:00
|
|
|
|
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](https://raw.githubusercontent.com/caraus-ecms/graphql/master/LICENSE)
|
2015-09-12 12:54:05 +02:00
|
|
|
|
|
2019-08-04 12:38:01 +02:00
|
|
|
|
GraphQL implementation in Haskell.
|
|
|
|
|
|
|
|
|
|
This implementation is relatively low-level by design, it doesn't provide any
|
|
|
|
|
mappings between the GraphQL types and Haskell's type system and avoids
|
2019-08-26 10:14:46 +02:00
|
|
|
|
compile-time magic. It focuses on flexibility instead, so other solutions can
|
|
|
|
|
be built on top of it.
|
2019-08-04 12:38:01 +02:00
|
|
|
|
|
|
|
|
|
## State of the work
|
|
|
|
|
|
2020-07-02 07:33:03 +02:00
|
|
|
|
For now this only provides a parser and a printer for the GraphQL query language
|
|
|
|
|
and allows to execute queries and mutations using the given schema, but without
|
|
|
|
|
the validation step. But the idea is to be a Haskell port of
|
2019-08-04 12:38:01 +02:00
|
|
|
|
[`graphql-js`](https://github.com/graphql/graphql-js).
|
|
|
|
|
|
|
|
|
|
For the list of currently missing features see issues marked as
|
|
|
|
|
"[not implemented](https://github.com/caraus-ecms/graphql/labels/not%20implemented)".
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
API documentation is available through
|
2020-04-12 08:32:39 +02:00
|
|
|
|
[Hackage](https://hackage.haskell.org/package/graphql).
|
2019-08-04 12:38:01 +02:00
|
|
|
|
|
|
|
|
|
You'll also find a small tutorial with some examples under
|
|
|
|
|
[docs/tutorial](https://github.com/caraus-ecms/graphql/tree/master/docs/tutorial).
|
2015-09-12 12:54:05 +02:00
|
|
|
|
|
2020-04-12 08:32:39 +02:00
|
|
|
|
## Further information
|
|
|
|
|
|
|
|
|
|
- [Contributing guidelines](CONTRIBUTING.md).
|
|
|
|
|
- [Changelog](CHANGELOG.md) – this one contains the most recent changes;
|
|
|
|
|
individual changelogs for specific versions can be found on
|
|
|
|
|
[Hackage](https://hackage.haskell.org/package/graphql).
|
|
|
|
|
|
2015-09-12 12:54:05 +02:00
|
|
|
|
## Contact
|
|
|
|
|
|
|
|
|
|
Suggestions, contributions and bug reports are welcome.
|
|
|
|
|
|
2019-08-04 12:38:01 +02:00
|
|
|
|
Should you have questions on usage, please open an issue and ask – this helps
|
|
|
|
|
to write useful documentation.
|
|
|
|
|
|
2015-09-18 14:55:59 +02:00
|
|
|
|
Feel free to contact on Slack in [#haskell on
|
|
|
|
|
GraphQL](https://graphql.slack.com/messages/haskell/). You can obtain an
|
2015-09-12 12:54:05 +02:00
|
|
|
|
invitation [here](https://graphql-slack.herokuapp.com/).
|