GraphQL over SSE documentation #185
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rafalp
requested changes
Jan 9, 2025
| @@ -472,3 +472,60 @@ graphql = GraphQL( | |||
| ), | |||
| ) | |||
| ``` | |||
|
|
|||
| ## Using Server-Sent Events Protocol | |||
There was a problem hiding this comment.
We are using double blank line between headers for visual separation in markdown too:
Suggested change
| ## Using Server-Sent Events Protocol | |
| ## Using Server-Sent Events Protocol |
docs/subscriptions.md
Outdated
|
|
||
| ## Using Server-Sent Events Protocol | ||
|
|
||
| In addition to subscriptions over WebSockets, Ariadne also allows an alternative subscriptions approach, `graphql-sse`, |
There was a problem hiding this comment.
This should be reworded and hard linebreak removed:
Instead of WebSockets, [Server-Sent Events (SSE)](https://github.com/enisdenjo/graphql-sse/blob/master/PROTOCOL.md) can be used as a transmission protocol for subscriptions. This approach uses single, long-lived HTTP connection to push data to clients.
docs/subscriptions.md
Outdated
| Server-Sent Events (SSE) allow servers to push data to web clients over HTTP through a single, long-lived connection. | ||
|
|
||
| To enable subscriptions over Server-Sent Events, initialize the `ariadne.asgi.GraphQL` app with | ||
| a `ariadne.contrib.sse.GraphQLHTTPSSEHandler` instance: |
There was a problem hiding this comment.
Suggested change
| a `ariadne.contrib.sse.GraphQLHTTPSSEHandler` instance: | |
| an `ariadne.contrib.sse.GraphQLHTTPSSEHandler` instance: |
docs/subscriptions.md
Outdated
| Subscriptions can be consumed using the [graphql-sse](https://github.com/enisdenjo/graphql-sse/) JavaScript client | ||
| library or any other compatible implementation. | ||
|
|
||
| > The `GraphQLHTTPSSEHandler` only supports asynchronous servers, due to the nature of subscriptions. |
There was a problem hiding this comment.
Suggested change
| > The `GraphQLHTTPSSEHandler` only supports asynchronous servers, due to the nature of subscriptions. | |
| > The `GraphQLHTTPSSEHandler` requires the ASGI server to work. |
|
Thanks for the feedback @rafalp! Everything has been included in the recent commit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for mirumee/ariadne#1195