Giter Site home page Giter Site logo

samurai016 / comuni-ita Goto Github PK

View Code? Open in Web Editor NEW
23.0 2.0 2.0 513 KB

Semplice API che permette di ottenere i comuni italiani in formato JSON, XML o CSV.

Home Page: https://comuni-ita.readme.io

License: MIT License

TypeScript 100.00%
api comuni-italiani deno redoc rest-api supabase supabase-functions typescript

comuni-ita's Introduction

Versione Hosted on Supabase Leggi la documentazione

Legacy project

Questa repository è la versione aggiornata della repository Comuni-ITA-legacy.
È possibile usare quella repository per installare una versione standalone dell'API non gestita con Supabase.

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.
I dati non ottenuti automaticamente dal sistema vengono inoltrati direttamente a me che procedo a verificarli e modificarli manualmente.

L'API è scaricabile e installabile su una propria istanza di Supabase oppure è usufruibile in maniera gratuita all'indirizzo https://axqvoqvbfjpaamphztgd.functions.supabase.co.
Dato che l'API è hostata su un servizio gratuito sarebbe opportuno evitare di sovraccaricare l'API per dare a tutti la possibilità di accedervi.

In questa wiki troverai una spiegazione di come funzionano gli endpoint e di come installare l'API su un server.

La documentazione è disponibile anche all'indirizzo https://comuni-ita.readme.io/

License: MIT
Credits: Logo inpired by: Castle by Jasfart from the Noun Project

Indice

Endpoints

Ottieni la lista di tutti i comuni italiani.

Ottieni la lista di tutti i comuni della regione indicata.

Ottieni la lista di tutti i comuni della provincia indicata.

Ottieni la lista di tutte le province italiane.

Ottieni la lista di tutte le province della regione indicata.

Ottieni la lista delle regioni italiane.

Dettagli sulle regioni e sulle province

Per evitare incongruenze coi nomi di regioni e province, si consiglia di verificare i nomi attraverso gli endpoint /regioni e /province.
In generale i nomi vanno scritti utilizzando i caratteri speciali come apostrofi, spazi o trattini.

Sistema di paging

A causa delle risorse limitate di Supabase, è stato implementato un sistema di paging per evitare di sovraccaricare il server.
Il sistema limita la risposa a 500 elementi per pagina.

Per ottenere i successivi 500 elementi è necessario specificare il parametro page nell'URL.
È possibile personalizzare il numero di elementi per pagina tramite il parametro pagesize nell'URL (limitato comunque a massimo 500 elementi).

Essendo gli endpoint /regioni e /province molto leggeri, non è necessario specificare il parametro page per ottenere tutti i risultati.

Installazione su server proprio

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

Sistema di aggiornamento

Il sistema di aggiornamento della API prevede un sistema di logging tramite un bot Telegram. Il bot serve, oltre che per essere notificati sullo stato dell'aggiornamento da remoto, sia per la risoluzione di eventuali problemi/conflitti occorsi durante il fetch automatico dei dati. Prima di poter installare l'API quindi, crea un bot Telegram tramite BotFather (Puoi chiamarlo come vuoi, il codice per il suo funzionamento è incluso in questa repo).

comuni-ita's People

Contributors

samurai016 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

domme1908 ubysoft

comuni-ita's Issues

Comuni cessati

Ciao non ho capito se in questa lista ci sono solo i comuni attivi o anche quelli cessati.

Comuni Duplicati

Alcuni comuni sono duplicati, questo crea problemi in fase di filtering, a breve compilerò una lista dei duplicati.

Problema con il CORS

Salve, le API mi ritornano un problema di cors non permettendomi di farmi accedere.
image

Comuni mancanti

Ciao!
Complimenti per il progetto e grazie per l'API!
Vorrei sapere ogni quanto vengono aggiornati i dati di comuni/province perché vedo che ne mancano diversi.
Ad esempio sulla sardegna, all'endpoint

https://axqvoqvbfjpaamphztgd.functions.supabase.co/province/sardegna

mi vengono restituite 5 province mentre su questo sito http://www.comuni-italiani.it/20/ ne vengono restituite 8.
Questo sito è solo un esempio, ho visto la stessa cosa anche su altri.

Di nuovo grazie mille

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.