Kiloapi es una API que nos permite gestionar la campaña Operación Kilo que se realiza todos los años en el mes de diciembre en nuestro colegio.
Para la ejecución de este proyecto, es necesario tener instalado Java 17, y Apache Maven. Además, para poder probar todas las peticiones más fácilmente, se recomienda el uso de Postman.
Para ejecutar el programa, debemos abrir CMD, ubicarnos en la carpeta del proyecto, y ejecutar el siguiente comando
mvn spring-boot:run
IMPORTANTE: Si el puerto 8080 se encuentra ocupado, la API no se iniciará. De ocurrir esto, debes introducir la siguiente linea en el archivo application.properties ubicado en ./src/main/resources
server.port=9000
Si el puerto 9000 tampoco estuviese libre, puedes probar con otros
Gracias a Postman, puedes probar las peticiones de una manera fácil y directa. Para ello, dentro del programa, solo debes importar el archivo kilosAPI.postman_collection.json ubicado en la carpeta raiz de KiloAPI
Tras ejecutar la app, podemos acceder a su documentación accediendo a la siguiente URL
http://localhost:8080/swagger-ui/index.html
Por otro lado, también es posible acceder al JSON que contiene toda la documentación mediante la siguiente URL
http://localhost:8080/v3/api-docs