sbruselario / georef-ar-api

API del Servicio de Normalización de Datos Geográficos de Argentina.

georef-ar-api

API del Servicio de Normalización de Datos Geográficos de Argentina.

Documentación

Para consultar la documentación de la API, acceder a https://apis.datos.gob.ar/georef.

Contenedores

Para correr los contenedores asegúrate de tener instalado docker-compose
El archivo de configuración puede correr dos servicios creando los siguientes contenedores:

• georef-api_es01: Un contenedor con Elasticsearch procesar e indexar los datos. Estos datos son almacenados y persistidos en un volumen de docker.
• georef-api_app: Un contenedor con la aplicación. Al correrlo la primera vez es necesario correr una indexación.

Antes de levantar el servicio de la app deberás generar un archivo config/georef.cfg que puedes hacerlo copiando el que ya existe (docker/georef.example.cfg) y renombrando ciertas variables. Tener en cuenta que dentro de la red de docker por defecto el host para el servidor de Elasticsearch es "es01" y el puerto es 9200.
Las carpetas config/; source/; backups/ y logs/ serán montadas dentro del contenedor de georef-api_app y se podrá acceder desde el host a los archivos generados por la app.

El archivo de configuración docker/georef.example.cfg está preparado para ser copiado al destino config/georef.cfg
La fuente de datos está configurada para ser leida desde la carpeta source/; pero si se desea se puede cambiar el archivo georef.cfg para especificar otra ruta o una URL. Si bien se puede copiar los archivos fuente dentro de /source, se recomienda crear un enlace duro; sobre todo si se están haciendo pruebas con el ETL en el mismo entorno de desarrollo.

cp -rl /home/georef-etl/files/latest /home/georef-api/source

Si se encuentra en otra partición se puede optar por un enlace simbólico:

ln /home/georef-etl/files/latest /home/georef-api/source

Para correr la aplicación:

Situarse dentro de la carpeta "docker" y correr el siguiente comando:

docker-compose up -d

Para indexar los archivos generados por el ETL correr el siguiente comando:

docker-compose exec app make index

Nota: Para más comandos referirse a la documentación (https://datosgobar.github.io/georef-ar-api/georef-api-development/#3-crear-los-indices)

El puerto utilizado por la aplicación es el 5000 y se mapea al mismo puerto del host. Ambos valores pueden ser modificados en el archivo docker-compose.yml

Para realizar consultas a la api se puede hacer una petición desde el host a dicho puerto.

Ejemplo:

curl localhost:5000/api/provincias

Nota: Para más endpoints referirse a la documentación (https://datosgobar.github.io/georef-ar-api/open-api/)

Si se modifica el código fuente reconstruir la imagen

docker-compose build app

Soporte

En caso de que encuentres algún bug, tengas problemas con la instalación, o tengas comentarios de alguna parte de Georef API, podés mandarnos un mail a [email protected] o crear un issue.