numeretti/pizzicore/README.md
2021-09-16 09:18:28 +02:00

811 B

Componente centrale del sistema pizzicaroli. tiene i conti. espone HTTP e WebSocket.

Alcune API richiedono autenticazione.

Il docker incluso è solo per comodità di sviluppo, non è strettamente necessario.

Concetti

Contatori multipli

Il codice gestisce più di un contatore, per generalità, anche se non è chiaro se questa cosa ci servirà. I contatori partono da 0, quindi in genere useremo sempre 0.

Storage

Il sistema ha un suo storage, in modo che al riavvio i contatori ripartano da dove erano.

HTTP API

GET /counter/0 ti dà il valore

POST /counter/0/increment incrementa, ma richiede basic-auth

WebSocket API

/ws/counter/0 ti dà il valore e ti riaggiorna ogni volta che questo cambia. Ignora ogni messaggio in ingresso.

TODO

  • configurazione
  • esempi d'uso