This is an api that expose Italian municipality information. It takes data from istat website and expose it to the client in json format
Here are URL where it takes the data:
- https://www.istat.it/storage/codici-unita-amministrative/Elenco-comuni-soppressi.zip
- https://www.istat.it/storage/codici-unita-amministrative/Elenco-comuni-italiani.csv
- https://www.istat.it/storage/codici-unita-amministrative/Elenco-denominazioni-precedenti.zip
npm install
you need to use these env variables. Feel free to change it in order to strict your envoirement rules.
NODE_ENV=development
HOST=0.0.0.0
PORT=3000
COMUNI_JSON_FILE=comuni.json
The project has on its dependencies dotenv, so you can use the .env.example file provided (remove the .example notation) or use it in CLI using export command or whatever you like.
npm run update:comuni
npm run start
Returns json data about all Italian comuni.
-
URL
/comuni
-
Method:
GET -
Data Params
provincia=[string]regione=[string]
-
Example
curl -X GET http://127.0.0.1:3000/comuni?provincia=bs -H 'Content-Type: application/json'
Returns json data about a single Italian comune.
-
URL
/comuni/:comune
-
Method:
GET -
Url Params
comune=[string]
-
Example
curl -X GET http://127.0.0.1:3000/comuni/brescia -H 'Content-Type: application/json'
Returns an array of Italian regioni
-
URL
/regioni
-
Method:
GET -
Example
curl -X GET http://127.0.0.1:3000/regioni -H 'Content-Type: application/json'
Returns an array of Italian province
-
URL
/province
-
Method:
GET -
Example
curl -X GET http://127.0.0.1:3000/province -H 'Content-Type: application/json'
build container
docker build --build-arg PORT=3000 -t comuni-service .
run container
docker run -d -p 3000:3000 comuni-service --env-file ./.env
update comuni in container
docker exec -i container_name node /app/bin/updateComuni.js