https://github.com/octaviosancho-dev/api-clientes
.NET Clients Web Api
https://github.com/octaviosancho-dev/api-clientes
api-rest automapper entity-framework-core netcore sql-server swagger
Last synced: 7 months ago
JSON representation
.NET Clients Web Api
- Host: GitHub
- URL: https://github.com/octaviosancho-dev/api-clientes
- Owner: octaviosancho-dev
- Created: 2023-11-09T22:46:18.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-10T02:09:04.000Z (about 1 year ago)
- Last Synced: 2025-01-21T14:45:27.782Z (about 1 year ago)
- Topics: api-rest, automapper, entity-framework-core, netcore, sql-server, swagger
- Language: C#
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Api Clientes (.NET 6)
## Descripción
Este proyecto es una Api REST desarrollada en el entorno de .NET 6 enfocada a la administracion de Clientes pudiendo agregar, editar, visualizar o eliminar registros de los mismos.
## Tecnologías y metodologías utilizadas
- .NET Core (.NET 6)
- Entity Framework Core
- Entity Framework Core Tools (SqlServer)
- Automapper
- Code First
- Swagger
## Instalación
Es necesario tener Visual Studio y .NET instalados, o tambien puede correrse en Visual Studio Code. Puede clonar el repositorio o descargarlo en forma de zip comprimido. Luego de abrirlo en Visual Studio, debe compilar la solucion y correrlo en debug (tambien se puede crear una version de Release para produccion de la api).
Luego, presione F5 o en el boton de ejecutar aplicacion. Se abrira una ventana con Swagger (herramienta que nos permite manejar solicitudes HTTP de una manera facil para probar la API, tambien podria utilizarse Postman o Insomnia, etc...).
Listo, de esta manera ya puede consultar, agregar, modificar o eliminar registros, al principio no vera clientes en su base de datos porque localmente no se ha creado ninguno.
Para ver la informacion de los clientes debe abrir en Visual Studio la ventana de "SQL Server Object Explorer" e ir la tabla de Clientes en la Base de Datos:
Por ultimo presione en la tabla Clientes click derecho -> View Data (o Ver Información)
## Endpoints
Consta de 6 diferentes endpoints para realizar las peticiones mencionadas anteriormente. Podra utilizarlos facilmente utilizando Swagger al correr la aplicación:
- GetAll (GetAll): Devuelve una lista de todos los clientes
- Get (GetById): Devuelve un cliente especifico
- Search (SearchByNombre): Trae una lista de registros que contengan los parametros de busqueda en los Nombres del cliente
- Insert (Post): Agrega un nuevo cliente a la base de datos
- Update (Put): Edita un cliente ya existente
- Delete: Elimina un cliente de la base de datos
## Validaciones
Existen validaciones para la informacion que se envía a traves de los endpoints en cada parametro, que pueden ser tanto de: formatos especificos, tipo de caracteres, campos requeridos, entre otras.
## Propiedades de los Clientes
- ID (unique - Primary Key)
- Nombres (string)
- Apellidos (string)
- Fecha de Nacimiento (DateTime)
- CUIT (string)
- Domicilio (string)
- Telefono Celular (string)
- Email (string)