API Gestion de Usuarios

Tecnologías

Java 17
Spring Boot 3.3.3
Maven 3x
JPA
H2
JWT

Diagrama de Secuencia

secuence-diagram

Como Ejecutarla

La aplicación es empaquetada como un jar con un Tomcat embebido. Por ende no es necesario instalar tomcat.

Pasos

Clonar repositorio
Asegurarse de usar JDK 17 and Maven 3.x
Crear jar con

 mvn clean package

Una vez construido el jar es posible correr la aplicación empleando alguno de los siguientes metodos: Ingresar a la carpeta target/ con cd .\target\ y luego:
```
java -jar .\users.api-0.0.1-SNAPSHOT.jar
```
O directamente en la carpeta raiz del proyecto:
```
mvn spring-boot:run
```

Una vez ejecutada debería aparecer algo como esto en la consola:

2024-09-05T09:15:26.283-05:00  INFO 33508 --- [  restartedMain] o.s.b.d.a.OptionalLiveReloadServer       : LiveReload server is running on port 35729
2024-09-05T09:15:26.314-05:00  INFO 33508 --- [  restartedMain] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port 8080 (http) with context path '/'
2024-09-05T09:15:26.314-05:00  INFO 33508 --- [  restartedMain] com.ns.users.api.Application             : Started Application in 3.998 seconds (process running for 4.513)

Acceso y Pruebas

Enpoints

Servicios

http://localhost:8080/api

Base de Datos H2

http://localhost:8080/h2-console

Colección postman para pruebas

../resources/NS USERS APP.postman_collection.json

postman-collection

Consulta usuarios (Base de datos vacía)

    http://localhost:8080/api/users

get-users-empty

Registro Nuevo Usuario de manera exitosa

Se crea con los datos: correo, contraseña, nombre, telefonos y rol

    http://localhost:8080/api/users

post-create-user-succesful

Registro Nuevo Usuario mensaje error

    http://localhost:8080/api/users

post-create-user-error

Intento acceso No Autorizado

Usuario que no está registrado

    http://localhost:8080/api/users

access-denied

Acceso Exitoso

Se ingresa correo y contraseña registrados previamente

    http://localhost:8080/api/auth/login

access-succesful

Obtener todos los usuarios registrados

Usuario registrado, se usa token generado para poder consultar la lista de usuarios almacenados

    http://localhost:8080/api/auth/login

get-users-list

Acceso a la Base de Datos H2

(Credenciales en archivo application.yml)

    http://localhost:8080/h2-console

ui-1-h2-console-db

Consulta de Usuarios creados

ui-h2-console-db

Acceso al contrato Swagger generado automaticamente

http://localhost:8080/swagger-ui/index.html

swagger-doc

http://localhost:8080/v3/api-docs

swagger-doc-2

Pruebas Unitarias: Ejecución y generación de reporte HTML

mvn test
mvn surefire-report:report

El primer comando ejecuta las pruebas, y el segundo comando genera el reporte HTML.

El reporte HTML se genera en el directorio target/site de tu proyecto. Puedes abrir el archivo surefire-report.html en un navegador para ver el reporte.

La ruta completa al archivo suele ser:

target/site/surefire-report.html

eocandos / ns-users-api

readme