avana/numeretti
3
0
Fork 0
Code Issues 2 Pull requests Releases Activity

readme su pizzicore

Browse source
This commit is contained in:
boyska 2021-09-16 02:47:45 +02:00
parent 93f67504c9
commit fabbc9f978
1 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
pizzicore/README.md
View file

@ -3,4 +3,26 @@ espone HTTP e WebSocket.
Alcune API richiedono autenticazione.
Il docker-compose incluso è solo per comodità di sviluppo, non è strettamente necessario.
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.