Skip to content

Latest commit

 

History

History
106 lines (94 loc) · 10.6 KB

README_es.md

File metadata and controls

106 lines (94 loc) · 10.6 KB
Raw

API-COLOMBIA

Introducción

API Colombia es una API pública RESTful que permite a los usuarios obtener una variedad de información pública sobre Colombia.

Características de soporte del proyecto

  • Minimal API's endpoints para obtener información sobre:
    • Información general sobre el país.
    • Departamentos/Estados.
    • Ciudades.
    • Presidentes.
    • Atracciones turísticas.
  • Documentación Swagger.
  • No requiere autenticación.

Versiones

  • 1.0

Guía de instalación

  • Clona este repositorio aquí.
  • La rama "develop" es la rama más estable en cualquier momento, asegúrate de estar trabajando en ella.
  • Se debe instalar .NET CORE SDK en la máquina.
  • Actualiza la cadena de conexión con tu base de datos preferida en el archivo "appsettings.json".
  • Ejecuta el comando dotnet build para generar la compilación del proyecto.

Uso

La página pública api-colombia.com tiene información útil sobre la API y una breve descripción de los endpoints disponibles y la misma permite el acceso a los endpoints descritos a continuación.

  • La documentación de swagger se puede encontrar en la siguiente URL

API Endpoints

Verbos HTTP Endpoints Acción
GET /api/{version}/city Obtiene la lista de todas las ciudades
GET /api/{version}/city/{id} Obtiene la información de una ciudad por su id
GET /api/{version}/city/name/{name} Obtiene la información de una ciudad por su nombre
GET /api/{version}/city/search/{keyword} Obtiene la información de una ciudad buscando por una palabra clave
GET /api/{version}/city/pagedList Obtiene la lista de todas las ciudades paginadas
GET /api/{version}/country/Colombia Obtiene la información de Colombia
GET /api/{version}/Department Obtiene la lista de todos los departamentos en Colombia
GET /api/{version}/Department/{id} Obtiene la información de un departamento por su id
GET /api/{version}/Department/name/{name} Obtiene la información de un departamento por su nombre
GET /api/{version}/Department/search/{keyword} Obtiene la información de un departamento que busca por una palabra clave
GET /api/{version}/Department/pagedList Obtiene la lista de todos los departamentos paginados
GET /api/{version}/Region Obtiene la lista de todas las regiones en Colombia
GET /api/{version}/President Obtiene la lista de todos los presidentes en Colombia
GET /api/{version}/President/{id} Obtiene la información de un presidente por su id
GET /api/{version}/President/name/{name} Obtiene la información de un presidente por su nombre
GET /api/{version}/President/year/{name} Obtiene la información de un presidente que gobernó durante un año específico
GET /api/{version}/President/search/{keyword} Obtiene la información de un presidente que busca por una palabra clave
GET /api/{version}/President/pagedList Obtiene la lista de todos los presidentes paginados
GET /api/{version}/TouristicAttraction Obtiene la lista de todas las atracciones turísticas en Colombia
GET /api/{version}/TouristicAttraction/{id} Obtiene la información de una atracción turística por su identificación
GET /api/{version}/TouristicAttraction/name/{name} Obtiene la información de una atracción turística por su nombre
GET /api/{version}/TouristicAttraction/search/{keyword} Obtiene la información de una atracción turística buscando por una palabra clave
GET /api/{version}/TouristicAttraction/pagedList Obtiene la lista de todas las atracciones turísticas paginadas

Ejemplo de Respuesta

  • Content type: "application/json". Las respuestas son objetos JSON.
  • El encabezado de respuesta contiene el código HTTP con el estado.
  • Ejemplo:
 {"id":1,"name":"Colombia","description":"Colombia, officially the Republic of Colombia, is a country in South America with insular regions in North America—near Nicaragua's Caribbean coast—as well as in the Pacific Ocean. The Colombian mainland is bordered by the Caribbean Sea to the north, Venezuela to the east and northeast, Brazil to the southeast, Ecuador and Peru to the south and southwest, the Pacific Ocean to the west, and Panama to the northwest. Colombia is divided into 32 departments and the Capital District of Bogotá, the country's largest city. It covers an area of 1,141,748 square kilometers (440,831 sq mi), and has a population of 52 million. Colombia's cultural heritage—including language, religion, cuisine, and art—reflects its history as a Spanish colony, fusing cultural elements brought by immigration from Europe and the Middle East, with those brought by enslaved Africans, as well as with those of the various Indigenous civilizations that predate colonization. Spanish is the official state language, although English and 64 other languages are recognized regional languages.","stateCapital":"Bogotá","surface":1141748,"population":52235050,"languages":["Spanish","English"],"timeZone":"UTC-5","currency":"Colombian Peso","currencyCode":"COP","isoCode":"CO","internetDomain":".co","phonePrefix":"+57","radioPrefix":"HK","aircraftPrefix":"HK"}

Tecnologías utilizadas

  • .NET Core 6.* es una plataforma de desarrollo gratuita, multiplataforma y de código abierto para crear muchos tipos de aplicaciones. .NET se basa en un tiempo de ejecución de alto rendimiento(high-performance runtime) que se usa en producción en muchas aplicaciones de gran escala.
  • PostgreSQL s un potente sistema de base de datos relacional de objetos de código abierto con más de 35 años de desarrollo activo que le ha valido una sólida reputación por su fiabilidad, robustez de características y rendimiento.
  • Microsoft Azure La plataforma en la nube de Azure consta de más de 200 productos y servicios en la nube diseñados para ayudarle a dar vida a nuevas soluciones, para resolver los desafíos actuales y crear el futuro. Cree, ejecute y administre aplicaciones en múltiples nubes, en las instalaciones y en el perímetro, con las herramientas y los marcos de su elección.

Contribuidores ✨

Todos los colaboradores

Gracias a estas maravillosas personas (emoji key):

Miguel Teheran
Miguel Teheran
💻		 Rina Plata
Rina Plata
📖 ✅		 Veronica Guaman
Veronica Guaman
💻		 Mario Botero
Mario Botero
💻		 Alejandro Herreño
Alejandro Herreño
📖 💻
Agrega tus contribuciones

Este proyecto sigue la especificación all-contributors. Las contribuciones de cualquier tipo son bienvenidas!

Licencia

Licencia MIT