Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Gianmatteo Palmieri authored Jul 9, 2020
1 parent 63a726f commit dde5c7b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@
Open Source REST API per informazioni sui terremoti
</h3>

Questa REST API permette di ottenere informazioni sui terremoti degli ultimi 7 giorni registrati dalla **Rete Sismica Nazionale**.
Questa REST API permette di ottenere informazioni sui terremoti registrati dalla **Rete Sismica Nazionale** negli ultimi sette giorni.
I dati sono ricavati dai tweet postati dall'account Twitter dell'**Istituto Nazionale di Geofisica e Vulcanologia** ([@INGVterremoti](https://twitter.com/INGVterremoti)).


## Uso

Per usufruire dell'API è necessario fare delle richieste `GET` o `POST` all'url `https://mrgian.it/terremoti` (oppure all'url `http://localhost:8080` se si fa partire l'applicazione su una macchina locale) specificando la rotta e il body della richiesta a seconda dei dati che si vuole ricevere.
Per usufruire dell'API è necessario fare delle richieste `GET` o `POST` all'url `https://mrgian.it/terremoti` (oppure all'url `http://localhost:8080` se si esegue l'applicazione su una macchina locale) specificando la rotta e il body della richiesta a seconda dei dati che si vuole ricevere.

## Rotte

|Tipo|Rotta |Descrizione |
|----|-------------------------------------|---------------------------------------------------------------|
|GET |`/terremoti` |Restituisce le informazioni sui terremoti |
|GET |`/terremoti/stats` |Restituisce la media di terremoti al giorno|
|GET |`/terremoti/stats?field=<campo>` |Restituisce le statistiche del campo specificato (i campi validi sono `valoreMagnitudo` e `profondita`|
|GET |`/terremoti/stats?field=<campo>` |Restituisce le statistiche del campo specificato (i campi validi sono `valoreMagnitudo` e `profondita`)|
|GET |`/terremoti/metadata` |Restituisce i metadati |
|POST|`/terremoti` |Restituisce le informazioni sui terremoti filtrati con le regole specificate nel body della richiesta (vedi la sezione **Filtri**)|
|POST|`/terremoti/stats` |Restituisce la media di terremoti al giorno, calcolata solo con i terremoti filtrati con le regole specificate nel body della richiesta (vedi la sezione **Filtri**)|
Expand Down Expand Up @@ -139,7 +139,7 @@ il seguente esempio filtra i terremoti che sono avvenuti dal 2 luglio 2020:

```
{
"<=": [
">=": [
{
"var": "data"
},
Expand Down

0 comments on commit dde5c7b

Please sign in to comment.