API

Este repositorio muestra una API creada mediante la tecnología de .net core 3.1 y el uso del ORM Entity Framework para las entidades de la base de datos.

Prerequisitos para la ejecución de la API

1. Asegurese de primero ejecutar el script DB_Sector_Zona.sql, el cual es la base de datos usada por esta API.
2. Tener instalado los siguientes paquetes NuGet:
   • Microsoft.EntityFrameworkCore.SqlServer
   • Microsoft.EntityFrameworkCore.Tools
   • Swashbuckle.AspNetCore.SwaggerGen
   • Swashbuckle.AspNetCore.SwaggerUI

Sobre la API

Esta API es la utilizada en la aplicación que se encuentra en el repositorio PruebaReact, entre las funciones que tiene esta API estan la creación, actualización, consulta y eliminación de los diferentes registros de personas que tendrán su nombre, sueldo y que pertenecen a una zona y sector respectivo de la ciudad de Guayaquil. Así mismo ofrece la posibilidad de consultar las zonas y sectores que se encuentran almacenados en la base de datos.

Documentación

A continuación se muestran los diferentes endpoints que existen en la API.

Endpoints

Verb	Path	Action
GET	api/codigo/consultar	Obtiene el ID del último registro creado para una persona
GET	api/persona/listarPersonas	Obtiene la información de todas las personas registradas
POST	api/persona/crear	Crea un nuevo registro de persona
PUT	api/persona/actualizar	Actualiza la información de una persona
DELETE	api/persona/eliminar	Elimina el registro de una persona mediante el código de dicha persona
POST	api/persona/consultarPersonaSueldo	Obtiene una lista de todas las personas con su sueldo respectivo mediante el codigo de zona
GET	api/sector/listar	Obtiene una lista de todos los sectores registrados
POST	api/usuario/login	Envia las credenciales para la autenticación del usuario
POST	api/zona/listarZonas	Obtiene una lista de las zonas por el código del sector
GET	api/zonasector/consultarZonaSector	Obtiene una lista de todos los sectores y el total de sueldos en dicho sector agrupados por zonas

Ejemplos del uso de la API

Validación de inicio de sesión

Para iniciar sesión debe de usar el path:

    api/usuario/login

Y agregar este cuerpo a la solicitud HTTP

{
	"nomUsuario": "admin",
	"password": "123"
}

El resultado enviado por el servidor será el siguiente

{
	"status": 200,
	"result": true
}

Donde status hará referencia al estado de la petición HTTP y result traerá el resultado que se espera, en este caso true que significa que las credenciales de usuario son correctas.

Creación de registro de nueva persona

Para crear un registro para una nueva persona deberá usar el path:

	api/persona/crear

Y agregar este cuerpo a la solicitud HTTP

{
	"codPersona": 6,
	"nomPersona": "Viviana González",
	"fecNacimiento": "1993-11-18",
	"codSector": 1,
	"codZona": 2,
	"sueldo": 650
}

El resultado enviado por el servidor será el siguiente

{
	"status": 200,
	"result": "Registro de persona creado correctamente"
}

Para la actualización de la información de una persona puede usar el mismo formato json que se uso para la creación de la persona.

Eliminación del registro de una persona

Para eliminar el registro en base de datos de una persona deberá usar el path:

	api/persona/eliminar

Y agregar este cuerpo a la solicitud HTTP

{
	"codPersona": 6
}

El resultado enviado por el servidor será el siguiente

{
	"status": 200,
	"result": "Se ha eliminado el registro correctamente"
}

Consulta de personas y sus sueldos por zonas

Para consultar las personas con sus respectivos sueldos mediante las zonas a las que pertenecen deberá de usar el path:

	api/persona/consultarPersonaSueldo

Y agregar este cuerpo a la solicitud HTTP

{
	"codZona": 3
}

El resultado enviado por el servidor será el siguiente

{
	"status": 200,
	"result": [
		{
			"codPersona": 3,
			"nomPersona": "Guillermo Rivera",
			"sueldo": 500
		},
		{
			"codPersona": 4,
			"nomPersona": "Carlos Alcívar",
			"sueldo": 560
		}
	]
}

Consulta de zonas por sector

Para consultar las zonas que hay registradas deberá de usar el path:

	api/zona/listarZonas

Y agregar este cuerpo a la solicitud HTTP

{
	"codSector": 1
}

El resultado enviado por el servidor será el siguiente

{
	"status": 200,
	"result": [
		{
			"codZona": 1,
			"desZona": "Alborada",
			"codSector": 1
		},
		{
			"codZona": 2,
			"desZona": "Sauces",
			"codSector": 1
		}
	]
}