Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 4.65 KB

README.md

File metadata and controls

95 lines (64 loc) · 4.65 KB
Raw

RetrieveCountriesAPI

Patrocina a rgdevment Estado de la compilación Cobertura Estado de la calidad Licencia: MIT

RetrieveCountriesAPI es una API REST de código abierto bajo la licencia MIT que te permite consultar datos sobre países, ciudades y otra información relevante en todo el mundo. Esta API está en continuo desarrollo y crecimiento.

Disponible en otros idiomas:

⚠️ Aviso Importante / Important Notice

Nos movimos. Este repositorio ya no tendrá soporte y la API junto con su documentación ahora se encuentran en: https://github.com/rgdevment/retrieve-countries

  • La API seguirá siendo consumible, gratis y opensource. Los contratos se mantienen igual.
  • Migramos el código base de Java a JavaScript por razones de optimización de recursos y costos.

No es que no me guste Java; es un gran lenguaje y lo utilizo a diario en mi trabajo. Sin embargo, para una API pública y de código abierto, los recursos y costos son más elevados, y debemos optimizarlos para mantenernos a largo plazo.

  • Cambio de tecnologías: De Spring Boot y Java 21 a NestJS y Node 20.
  • Continuamos en desarrollo y mejorando día a día.

Gracias por tu apoyo y comprensión.

Consulta la documentación en: https://countries.apirest.cl/v1/docs

Documentación

Ejemplos de uso

Puedes obtener información sobre un país y sus ciudades con esta simple llamada:

curl -X GET "https://countries.apirest.cl/v1/chile"

O, si lo prefieres, puedes obtener todos los países de una región específica:

curl -X GET "https://countries.apirest.cl/v1/region/americas"

Incluso puedes obtener todos los países del mundo con una sola petición:

curl -X GET "https://countries.apirest.cl/v1/all"

También puedes mostrar u ocultar información adicional con los siguientes parámetros opcionales:

  • excludeCities (opcional): booleano
  • excludeStates (opcional): booleano

Para más información y otros endpoints, consulta la Documentación en Postman o Swagger.

Ejecución del proyecto localmente

Requisitos

  • Java: 21
  • Spring Boot: 3.x
  • Gradle: Utiliza el wrapper gradlew incluido.

Instalación

  1. Clona el repositorio:

  2. Ejecuta la aplicación:

    • Para modo desarrollo: ./gradlew bootRun
    • Para construir producción: ./gradlew build

  3. Accede a la API localmente en:

Donaciones

Este proyecto se mantiene de manera gratuita para todos. Si encuentras útil esta API y deseas apoyar su mantenimiento, puedes contribuir con una donación voluntaria.

Las donaciones se destinarán exclusivamente a cubrir los costos de infraestructura, que incluyen:

  • Google Cloud Run: Servicio que aloja y ejecuta la API, cubriendo los costos de CPU, memoria y tiempo de ejecución.
  • Dominio: Los costos del registro y mantenimiento de los dominios apirest.cl y restapi.cl.
  • Almacenamiento: Si es necesario, los fondos cubrirán los costos de bases de datos externas o servicios de almacenamiento.
  • Tráfico de red: Costos adicionales relacionados con el uso de red y la transferencia de datos.
  • Certificados SSL: Parte de las donaciones se destinarán a la compra o renovación de certificados SSL para conexiones seguras, si es necesario.

¡Cualquier aporte es bienvenido y ayudará a mantener el servicio activo y disponible para todos!

Considera ser un patrocinador. ¡Gracias por tu apoyo!

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.