Skip to content

Support streaming API resources as server-sent events
Compare
Choose a tag to compare
@arucard21 arucard21 released this 23 May 13:01
· 2 commits to master since this release
v1.1.0
c24dbdf

This release adds support for receiving API resources as server-sent events. This can be used as an alternative to paging when you want to get all API resources.

This works by having the API set up a one-directional connection to the client, then sending each API resource (in JSON format) over that connection. Once all API resources are sent, an event marking the end of the collection is sent and the connection is closed.

This functionality requires the API to use at least version 1.1.0 of SimplyRESTful and to have the stream() functionality implemented. It is also strongly recommended to use HTTP/2 due to limitations with the amount of connections that can be made in earlier versions of HTTP.

Assets 2
Loading