api-blueprint
api-blueprint copied to clipboard
Support for realtime APIs
This is an advanced feature request – Dedicated syntax to support real time APIs.
This should primarily address following concepts:
- Long-polling
- Streaming
-
"Stream of lines"
Example APIs would be:
- CBIX (resource oriented)
- Twitter streaming API (one endpoint)
Note: This is NOT a feature request for WebSockets nor Webhooks.
Great to see this, Z.
At the high level, I'd change "Server-Sent Events" to simply "Streaming", as SSE is just one type of streaming format in the wild and you'll want to support at least two (the other one being "stream of lines"). In fact, the example APIs cited both use the lines format and not SSE.
Thanks for the explanation @jkarneges ! I have updated the original post.