LoicB / rest-api

NPedidos es una aplicación que permite la gestión simple de pedidos de menús de comidas, por fechas.

NPedidos - REST API

📚 Translations Readme:

Descripción

NPedidos es una aplicación que permite la gestión simple de pedidos de menús de comidas, por fechas.

Este proyecto proporciona los recursos a consumir por el proyecto web.

Demostración

No disponible, por el momento.

Despliegue local

• Requisitos
• Empezar a trabajar
  • Crear base de datos
  • Usando postman
  • Trabajando en IntelliJ IDEA
  • Acceder a swagger

Requisitos

• Java 17
• Maven 3.8.6
• MySQL 8
• Wildfly 26 (Opcional)

Empezar a trabajar

Crear base de datos

• Ejecutamos el script npedidos.sql

Usando postman

• Puedes hacer un fork a las API en el siguiente enlace:

  

Trabajando en IntelliJ IDEA

• Clonar proyecto
• Configurar maven home path
• Rellenar base de datos
• Compilar
• Ejecutar
• Iniciar sesión
• Otras configuraciones de RUN
• Habilitar EditorConfig
• Establecer opciones de guardado
• spring-boot-devtools

Clonar proyecto:

File > New > Project from Version Control

Establecer la ruta local de maven:

File > Settings > Build, Execution, Deployment > Build Tools > Maven

• maven home path

Compilar:

• Run > Run...
  • [clean,install]: Compila el proyecto.
  • [clean,install] No Test: Compila sin ejecutar los test.

Ejecutar aplicación:

• Run > Run...

  • App

  Si el usuario y contraseña, de la base de datos, es distinto a root, modificar la información de conexión del fichero src/main/resources/application-runner.properties

Rellenar la base de datos con registros de prueba:

• Run > Run...

  • db:seed: Rellenar la base de datos con registros.
  • db:fresh --seed: Borrar la base de datos y la rellena con registros.

  La aplicación debe estar detenida.

Iniciar sesión

• Al ejecutar db:seed la contraseña de los usuarios creados es igual al nombre de usuario.

Otras configuraciones de RUN:

• All: Ejecuta todos los test.

• API: Despliega el proyecto en Wildfly.

• API [clean, install]: Compila con maven y despliega el proyecto en wildfly.

  Configurar la ruta del servidor de wildfly.

Habilitar EditorConfig

• Es necesario tener habilitado el soporte de EditorConfig:

  Settings > Editor > Code Style

  • Enable Editor Config Support

Establecer acciones de guardado

• Recomiendo tener activado las acciones de guardado:
  • Reformat code
  • Optimize imports

Settings > Tools > Actions on save

Tener habilitado EditorConfig.

spring-boot-devtools

• Activar la compilación automática del proyecto:

Settings > Build, Execution, Development > Compiler

• Build project automatically

Acceder a swagger

Puedes acceder a la información de la API con swagger en las siguientes URL:

• http://localhost:8080/api/api-docs
• http://localhost:8080/swagger-ui/index.html

Al acceder se te pedirá ingresar un usuario y contraseña.

Previamente, rellenar la base de datos con datos de pruebas, ya que este proceso creara usuarios con los que puedes acceder. Por el momento cualquiera es válido para acceder.

Contribuir

Cualquier contribución que hagas será muy apreciada.

• Antes de empezar a codificar, lea las directrices de contribución.

Agradecimientos

Gracias a JetBrains por proporcionar una licencia para IntelliJ para desarrollar este proyecto.

JetBrains	IntelliJ

Licencia

MIT license.