Skip to content

Commit c9302c5

Browse files
committed
Aggiunto supporto a XML e CSV, aggiornata documentazione
1 parent 766a69c commit c9302c5

File tree

8 files changed

+1028
-59
lines changed

8 files changed

+1028
-59
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,39 @@
11
# [Comuni ITA API](https://samurai016.github.io/Comuni-ITA/)
2-
![Versione](https://img.shields.io/badge/versione-v3.0.2-%23007ec6?style=flat-square)
2+
![Versione](https://img.shields.io/badge/versione-v3.1.0-%23007ec6?style=flat-square)
33
[![Hosted on Supabase](https://img.shields.io/badge/Hosted%20on%20Supabase-passing?style=flat-square&logo=supabase&labelColor=1c1c1c&color=1c1c1c)](https://axqvoqvbfjpaamphztgd.functions.supabase.co)
44
[![Leggi la documentazione](https://img.shields.io/badge/Leggi%20la%20documentazione%20Swagger-passing?style=flat-square&logo=Read%20the%20Docs&labelColor=8CA1AF&color=8CA1AF&logoColor=white)](https://samurai016.github.io/Comuni-ITA/)
55

66
> ### Legacy project
77
> Questa repository è la versione aggiornata della repository [Comuni-ITA-legacy](https://github.com/Samurai016/Comuni-ITA-legacy).
88
> È possibile usare quella repository per installare una versione standalone dell'API non gestita con Supabase.
99
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.
1212

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.
1515

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.
1717

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.
1919

2020
**License:** [MIT](https://opensource.org/licenses/MIT)
2121
**Credits:** Logo inpired by: [Castle by Jasfart from the Noun Project](https://thenounproject.com/omataloon/)
2222

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+
2337
# Endpoints
2438

2539
## [![GET](https://img.shields.io/static/v1?label=%20&message=GET&color=187bdf&style=flat-square) /comuni](https://axqvoqvbfjpaamphztgd.functions.supabase.co/comuni)
@@ -63,6 +77,16 @@ Ottieni la lista delle regioni italiane.
6377
Per evitare incongruenze coi nomi di regioni e province, si consiglia di verificare i nomi attraverso gli endpoint `/regioni` e `/province`. \
6478
In generale i nomi vanno scritti utilizzando i caratteri speciali come apostrofi, spazi o trattini.
6579

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+
6690
# Installazione su server proprio
6791

6892
Tramite questa repo è possibile installare l'API su una propria istanza di Supabase.

0 commit comments

Comments
 (0)