The purpose of this library is to be your real-time zero-code API server.
Broker is a SSE message broker that requires you write no backend code to have a full real-time API.
Broker is born from the need that rather than building a complex REST API with web-sockets and a SQL database to provide reactive web forms (like for React) there must be a simpler way.
Broker follows an insert-only/publish/subscribe paradigm rather than a REST CRUD paradigm.
In Broker you create a user, login, then insert an event and its data with a timestamp. Broker publishes the event when the timestamp is reached to the event stream via SSE. Broker keeps all event versions in its database that can be viewed. Broker can also cancel future events.
When the client first subscribes to the SSE connection all the latest events and data is sent to the client. Combined with sending the latest event via SSE when subscribed negates the necessity to do any GET API requests in the lifecycle of an event.
The side-effect of this system is that the latest event is the schema. Old events are saved in the database and are not changed but the latest event is the schema for the front-end. This is pure NoSQL as the backend is agnostic to the event data.
/users
- POST JSON to create a user
json
{"username":{...}, "password":{...}, "info":{...}}
- where {...} is for username and string, password a string, and info any JSON you want
/login
- POST JSON to login
json
{"username":{...}, "password":{...}}
- where {...} is for username a string and password a string
will return
json
{"jwt":{...}}
- where {...} is a JWT (string)
/events (public)
- connect your sse-client to this endpoint
/insert (requires authenicatation)
- POST JSON to insert an event
json
{"event":{...}, "published": false, "timestamp":{...}, "data":{...}}
- where {...} is for the event a string, timestamp is the epoch unix timestamp when you want the event to become the current event, and data is any JSON you want
/collections/{event} (requires authenicatation)
- do a GET request where {event} is the name of the event you want the event log
/cancel/{uuid} (requires authenicatation)
- do a GET request where (uuid) is the event uuid you want to cancel - this will mark the event published and it will not be published to the event stream - the event uuid can be obtained from the response from /insert or from /collection/{event}.
```rust use broker::{broker_run};
async fn main() -> std::result::Result<(), std::io::Error> { brokerrun("http://localhost:3000".toowned()).await } ```
./tmp of the project rootmake