https://github.com/d-exclaimation/over-layer
A GraphQL over Websocket Stream-based Transport Layer on Akka.
https://github.com/d-exclaimation/over-layer
akka akka-actor akka-http akka-streams graphql graphql-over-websocket graphql-subscriptions graphql-ws sangria sangria-graphql sangria-subscriptions subscriptions-transport-ws websocket websockets
Last synced: 3 months ago
JSON representation
A GraphQL over Websocket Stream-based Transport Layer on Akka.
- Host: GitHub
- URL: https://github.com/d-exclaimation/over-layer
- Owner: d-exclaimation
- License: apache-2.0
- Created: 2021-09-13T07:36:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-05T13:00:12.000Z (about 3 years ago)
- Last Synced: 2024-12-29T12:39:04.528Z (5 months ago)
- Topics: akka, akka-actor, akka-http, akka-streams, graphql, graphql-over-websocket, graphql-subscriptions, graphql-ws, sangria, sangria-graphql, sangria-subscriptions, subscriptions-transport-ws, websocket, websockets
- Language: Scala
- Homepage: https://overlayer.netlify.app/
- Size: 188 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
OverLayer
A GraphQL over Websocket Stream-based Transport Layer on Akka.
## Setup
**Latest Version**: `1.0.3`
```sbt
"io.github.d-exclaimation" %% "over-layer" % latestVersion
```
## GraphQL Over Websockets
In the GraphQL world, we have the concept of a "subscription" which is a request from the client to subscribe a stream
of data that is sent from the server. This is usually done using websocket with a additional subprotocol.
This package is a websocket transport layer for managing, encoding, and
decoding [Sangria](https://github.com/sangria-graphql/sangria-akka-streams) stream based operations into the proper
sub-protocol format using Akka Actors.
## Usage/Examples
- [Documentation](https://overlayer.netlify.app/)
- [Getting Started](https://overlayer.netlify.app/docs/intro)
### Protocols
- [subscriptions-transport-ws](https://github.com/apollographql/subscriptions-transport-ws/blob/master/PROTOCOL.md)
- [graphql-ws](https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md)
### Feedback
If you have any feedback, feel free to reach out through the issues tab or through my
Twitter [@d_exclaimation](https://twitter.com/d_exclaimation).