|
1 | 1 | # [Comuni ITA API](https://samurai016.github.io/Comuni-ITA/)
|
2 |
| - |
| 2 | + |
3 | 3 | [](https://axqvoqvbfjpaamphztgd.functions.supabase.co)
|
4 | 4 | [](https://samurai016.github.io/Comuni-ITA/)
|
5 | 5 |
|
6 | 6 | > ### Legacy project
|
7 | 7 | > Questa repository è la versione aggiornata della repository [Comuni-ITA-legacy](https://github.com/Samurai016/Comuni-ITA-legacy).
|
8 | 8 | > È possibile usare quella repository per installare una versione standalone dell'API non gestita con Supabase.
|
9 | 9 |
|
10 |
| -Tramite questa REST API hai accesso ad una lista di tutti i comuni, le province e le regioni italiane. I dati sono ottenuti e aggiornamenti da un sistema di aggiornamento semiautomatico che preleva i dati direttamente dagli archivi ISTAT e integra le informazioni mancanti interrogando Wikidata. |
11 |
| -I dati non ottenuti automaticamente dal sistema vengono inoltrati direttamente a me che procedo a verificarli e modificarli manualmente. |
| 10 | +Tramite questa REST API hai accesso ad una lista di tutti i comuni, le province e le regioni italiane. I dati sono ottenuti e aggiornamenti da un sistema di aggiornamento semiautomatico che preleva i dati direttamente dagli archivi ISTAT e integra le informazioni mancanti interrogando Wikidata. |
| 11 | +I dati non ottenuti automaticamente dal sistema vengono inoltrati direttamente a me che procedo a verificarli e modificarli manualmente. |
12 | 12 |
|
13 |
| -L'API è scaricabile e installabile su una propria istanza di Supabase oppure è usufruibile in maniera gratuita all'indirizzo https://axqvoqvbfjpaamphztgd.functions.supabase.co. |
14 |
| -Dato che l'API è hostata su un servizio gratuito sarebbe opportuno evitare di sovraccaricare l'API per dare a tutti la possibilità di accedervi. |
| 13 | +L'API è scaricabile e installabile su una propria istanza di Supabase oppure è usufruibile in maniera gratuita all'indirizzo https://axqvoqvbfjpaamphztgd.functions.supabase.co. |
| 14 | +Dato che l'API è hostata su un servizio gratuito sarebbe opportuno evitare di sovraccaricare l'API per dare a tutti la possibilità di accedervi. |
15 | 15 |
|
16 |
| -In questa wiki troverai una spiegazione di come funzionano gli endpoint e di come installare l'API su un server. |
| 16 | +In questa wiki troverai una spiegazione di come funzionano gli endpoint e di come installare l'API su un server. |
17 | 17 |
|
18 |
| -La documentazione è disponibile anche all'indirizzo https://samurai016.github.io/Comuni-ITA/ sotto forma di documentazione Swagger. |
| 18 | +La documentazione è disponibile anche all'indirizzo https://samurai016.github.io/Comuni-ITA/ sotto forma di documentazione Swagger. |
19 | 19 |
|
20 | 20 | **License:** [MIT](https://opensource.org/licenses/MIT)
|
21 | 21 | **Credits:** Logo inpired by: [Castle by Jasfart from the Noun Project](https://thenounproject.com/omataloon/)
|
22 | 22 |
|
| 23 | +# Indice |
| 24 | + |
| 25 | +- [Endpoints](#endpoints) |
| 26 | + - [GET /comuni](#-comuni) |
| 27 | + - [GET /comuni/{regione}](#-comuniregione) |
| 28 | + - [GET /comuni/provincia/{provincia}](#-comuniprovinciaprovincia) |
| 29 | + - [GET /province](#-province) |
| 30 | + - [GET /province/{regione}](#-provinceregione) |
| 31 | + - [GET /regioni](#-regioni) |
| 32 | +- [Dettagli sulle regioni e sulle province](#dettagli-sulle-regioni-e-sulle-province) |
| 33 | +- [Sistema di paging](#sistema-di-paging) |
| 34 | +- [Installazione su server proprio](#installazione-su-server-proprio) |
| 35 | + - [Sistema di aggiornamento](#sistema-di-aggiornamento) |
| 36 | + |
23 | 37 | # Endpoints
|
24 | 38 |
|
25 | 39 | ## [ /comuni](https://axqvoqvbfjpaamphztgd.functions.supabase.co/comuni)
|
@@ -63,6 +77,16 @@ Ottieni la lista delle regioni italiane.
|
63 | 77 | Per evitare incongruenze coi nomi di regioni e province, si consiglia di verificare i nomi attraverso gli endpoint `/regioni` e `/province`. \
|
64 | 78 | In generale i nomi vanno scritti utilizzando i caratteri speciali come apostrofi, spazi o trattini.
|
65 | 79 |
|
| 80 | +# Sistema di paging |
| 81 | + |
| 82 | +A causa delle risorse limitate di Supabase, è stato implementato un sistema di paging per evitare di sovraccaricare il server. |
| 83 | +**Il sistema limita la risposa a 500 elementi per pagina.** |
| 84 | + |
| 85 | +Per ottenere i successivi 500 elementi è necessario specificare il parametro `page` nell'URL. |
| 86 | +È possibile personalizzare il numero di elementi per pagina tramite il parametro `pagesize` nell'URL (limitato comunque a massimo 500 elementi). |
| 87 | + |
| 88 | +**Essendo gli endpoint `/regioni` e `/province` molto leggeri, non è necessario specificare il parametro `page` per ottenere tutti i risultati.** |
| 89 | + |
66 | 90 | # Installazione su server proprio
|
67 | 91 |
|
68 | 92 | Tramite questa repo è possibile installare l'API su una propria istanza di Supabase.
|
|
0 commit comments