Actualizar 'README.md'

README.md

@@ -1,61 +1,303 @@
-# Guía de Desarrollo - Creación de Tablas y Consumo de Endpoints en el Backend YII 2
+# CrudAPI
+Desacoplando el Front-End 
+
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+  <summary>Tabla de Contenido</summary>
+  <ol>
+    <li>
+      <a href="#Acerca del Proyecto">Acerca del Proyecto</a>
+    </li>
+    <li>
+      <a href="#El archivo principal>El archivo principal</a>
+      <ul>
+        <li><a href="#Prerrequisitos">Diagramado de Interfaz grafica de usuario (GUI) Web con Balsamiq</a></li>
+        <li><a href="#Prerrequisitos">Modelado de bases de datos relacionales en UML</a></li>
+        <li><a href="#Prerrequisitos">Creación de la Base de Datos en SQL Managment Studio</a></li>
+        <li><a href="#Prerrequisitos">Creación Proyecto con Visual Studio tipo API Web Core 6.0</a></li>
+        <li><a href="#Prerrequisitos">Creación modelos mediante Object Relacional Mapping (ORM) Entitiy Framework modo Databasefirst</a></li>
+        <li><a href="#Prerrequisitos">Testeo manual de end-points "Get, Post, Put, Delete" mediante Visual Code extension Postman </a></li>
+	<li><a href="#Prerrequisitos">Desarrollo de Front-End Javascript</a></li>
+	<li><a href="#Prerrequisitos">Creacion de Pruebas Automatizadas mediante RobotFramework</a></li>	
+        <li><a href="#TODO">TODO</a></li>
+        <li><a href="#Tecnologias">Tecnologías</a></li>
+      </ul>
+    </li>
+  </ol>
+</details>
+
+
+# Diagrama Entidad Relación
+Desacoplando el Front-End 
+
+ <img src="Images/ER.PNG" alt="Logo">
+
+## SQL Query
+ 
+``` sql
+/* Creacion de la base de datos */
+Create Database ControlAutosDB
+
+USE [ControlAutosDB]
+GO
+/****** Object:  Table [dbo].[DestinoRuta]    Script Date: 9/7/2023 12:08:58 PM ******/
+SET ANSI_NULLS ON
+GO
+SET QUOTED_IDENTIFIER ON
+GO
+CREATE TABLE [dbo].[DestinoRuta](
+	[IdDestino] [int] IDENTITY(1,1) NOT NULL,
+	[NombreDestino] [varchar](100) NOT NULL,
+	[Estatus] [bit] NOT NULL,
+	[IdRuta] [int] NOT NULL,
+	[RutaDestino] [varchar](100) NULL,
+PRIMARY KEY CLUSTERED 
+(
+	[IdDestino] ASC
+)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON, OPTIMIZE_FOR_SEQUENTIAL_KEY = OFF) ON [PRIMARY]
+) ON [PRIMARY]
+GO
+/****** Object:  Table [dbo].[Ruta]    Script Date: 9/7/2023 12:08:58 PM ******/
+SET ANSI_NULLS ON
+GO
+SET QUOTED_IDENTIFIER ON
+GO
+CREATE TABLE [dbo].[Ruta](
+	[IdRuta] [int] IDENTITY(1,1) NOT NULL,
+	[NombreRuta] [varchar](60) NOT NULL,
+	[RutaInicio] [varchar](60) NOT NULL,
+	[Estatus] [bit] NOT NULL,
+PRIMARY KEY CLUSTERED 
+(
+	[IdRuta] ASC
+)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON, OPTIMIZE_FOR_SEQUENTIAL_KEY = OFF) ON [PRIMARY]
+) ON [PRIMARY]
+GO
+ALTER TABLE [dbo].[DestinoRuta]  WITH CHECK ADD  CONSTRAINT [FK_Cargo] FOREIGN KEY([IdRuta])
+REFERENCES [dbo].[Ruta] ([IdRuta])
+ON UPDATE CASCADE
+ON DELETE CASCADE
+GO
+ALTER TABLE [dbo].[DestinoRuta] CHECK CONSTRAINT [FK_Cargo]
+GO
+
+```
+# Bosquejos
+
+# Diagrama Diseño GUI
+Bosquejos tentativos
+
+ <img src="Images/GestinDesignMain.PNG" alt="Logo">
+
+
+# Diagrama Diseño GUI
+Bosquejos tentativos
+
+ <img src="Images/GestinDesign.PNG" alt="Logo">
+
+
+
+
+
+
+<!-- PROJECT LOGO -->
+<br />
 
-## Acerca del Proyecto
-Este documento tiene como objetivo proporcionar las pautas y pasos necesarios para llevar a cabo la creación de tablas y servir información mediante el consumo de endpoints o APIs en el backend.
 
-## El Archivo Principal
-El archivo principal contiene una serie de pasos detallados que deben seguirse para configurar y poner en marcha el proyecto. A continuación, se describen los principales puntos:
 
-### 1. Crear un Rol (Usuario) para la Base de Datos
-Se explicará cómo crear un rol de usuario específico para la base de datos, garantizando la seguridad y los permisos adecuados.
-Recuerda tener instalado el motor del posgres para poder operar la consola.
 <p align="center">
   <a>
-    <img src="Images/psql.PNG.PNG" alt="Logo">
+    <img src="Images/CrudAPI_MC.PNG" alt="Logo">
   </a>  
 </p>
 
+<p align="center">
+  <a>
+    <img src="Images/ProyectoTipoAPI.PNG" alt="Logo">
+  </a>
+</p>
 
-Ingresar el siguiente ejemplo desde la consola de (psql):
+<p align="center">
+  <a>
+    <img src="Images/diable_https.PNG" alt="Logo">
+  </a>
+</p>
+
+<p align="center">
+  <a>
+    <img src="Images/PrimerVista.PNG" alt="Logo">
+  </a>
+</p>
+
+<p align="center">
+  <a>
+    <img src="Images/EliminandoInfoDefault.PNG" alt="Logo">
+  </a>
+</p>
+
+<p align="center">
+  <a>
+    <img src="Images/PostManExtension.PNG" alt="Logo">
+  </a>
+</p>
+
+# Creación modelos mediante Object Relacional Mapping (ORM) Entitiy Framework modo Databasefirst
+
+1) Una vez generado el proyecto instalar con el gestor de paquetes de nutget las siguientes librerias:
+"procurar que sean las versiones recientes estables"
 ~~~
-create role "ed_puerta" with login password 'ed_puerta';
+ microsoft.entityframeworkcore.tools
+ microsoft.entityframeworkcore.sqlserver  
 ~~~
 
-### 2. Crear una Base de Datos
-Los pasos para la creación de la base de datos necesaria serán detallados, asegurando la correcta configuración del entorno de almacenamiento de datos.
-Ingresar el siguiente ejemplo desde la consola de (psql):
+Generar el contexto y modelos a partir de la base de datos mediante package manager console:
+mediante credenciales sql:
 ~~~
-create database "ed_puerta" with owner="ed_puerta" template=template0;
+ Scaffold-DbContext "Server=(local); Database=ControlAutosDB; user id=lorenzo; pwd= 123; Encrypt=False" Microsoft.EntityFrameworkCore.SqlServer -OutPutDir Models 
 ~~~
 
-### 3. Configurar en el Archivo `config/db.php`
-Se proporcionarán instrucciones sobre cómo configurar adecuadamente el archivo `db.php` para establecer la conexión entre la aplicación y la base de datos.
+mediante autentificacion de windows:
+~~~
+Scaffold-DbContext "Server=(local); DataBase=ControlAutosDB; Integrated Security=true; Encrypt=False" Microsoft.EntityFrameworkCore.SqlServer -OutPutDir Models
+~~~
+
+Recuerda tener habilitada las conecciones en el administrador de sql
+<p align="center">
+  <a>
+    <img src="Images/Haabilitar_Autentificacion_SQL.PNG" alt="Logo">
+  </a>  
+</p>
+
+Al terminar deberian aparecer la carpeta models, con los modelos y el contexto generado
+ [<img src="Images/ModelsEF.PNG" alt="Logo">](url)
+
+Debemos mover la cadena de \Models\ControlAutosDbContext.cs
+[<img src="Images/CadenaContext.PNG" alt="Logo">](url)
+
+
+appsettings.json
+``` json
+{
+  "ConnectionStrings": {
+    "cadenaSql": " Server=(local); DataBase=ControlAutosDB; Integrated Security=true; Encrypt=False"
+  },
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}
+
+```
+
+Es necesario agregar la cadena en Program.cs
+~~~
+builder.Services.AddDbContext<ControlAutosDbContext>(options => options.UseSqlServer(builder.Configuration.GetConnectionString("cadenaSql")));
+~~~
+
+
+
+# Generar un controller vacio con el siguiente codigo basico
+``` C#
+using CrudAPICM.Models;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.EntityFrameworkCore;
+
+namespace CrudAPICM.Controllers
+{
+    [Route("api/[controller]")]
+    [ApiController]
+    public class ControlAutoController : Controller
+    {
+        private static ControlAutosDbContext _contexControlAuto;
+        public ControlAutoController(ControlAutosDbContext context) { 
+            _contexControlAuto = context;
+        }        
+
+        [HttpGet]
+        public async Task<ActionResult<IEnumerable<Ruta>>> GetRutas() {
+
+            return await _contexControlAuto.Ruta.ToListAsync();
+        }
+    }
+}
+```
+Agregar los siguientes End-Points para el CRUD basico
+``` C#
+// GET: api/GetRutas
+// GET: api/GetRutaId/5        
+// POST: api/GetRutas
+// PUT: api/PutRuta/5
+// DELETE: api/DeleteRuta/5      
+```
+
+Una vez listos los end-points habilidar las politicas de dominio crusado en program.cs para poder consumir la api desde otro dominio.
+
+``` C#
+builder.Services.AddCors(options =>
+{
+    options.AddPolicy("PoliticaCliente",
+        policy =>
+        {
+            policy.AllowAnyOrigin()
+            .AllowAnyHeader()
+            .AllowAnyMethod();
+        });
+app.UseCors("PoliticaCliente");
+```
+
+1) client
+<p align="center">
+  <a>
+    <img src="Images/tomala.PNG" alt="Logo">
+  </a>  
+</p>
+2) client
+<p align="center">
+  <a>
+    <img src="Images/tomala2.PNG" alt="Logo">
+  </a>  
+</p>
 
-### 4. Clonar el Proyecto de PHP
-Instrucciones sobre cómo clonar el proyecto desde el repositorio de PHP para obtener la estructura base del proyecto.
 
-### 5. Migraciones
-Se describirá el proceso de migración, que implica aplicar y gestionar cambios en la base de datos a medida que evoluciona la aplicación.
+Si se presentan errores por cuestion de referencias cruzadas "no se pueden guardar los datos por la extension de exceso de memmoria y afecta la deserializacion mayor a 32 agregar la siguiente configuracion en program.cs file" 
+``` C
+// Ignorare Referencias Cruzada-
+builder.Services.AddControllers().AddJsonOptions(x =>
+                x.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles);
 
-### 6. Creación de Tablas
-Pasos detallados sobre la creación de tablas específicas, asegurando la coherencia y estructuración adecuada de los datos.
+```
+Asegurate que cuando pruebes con swager el objeto relacionado no sea del tipo string.
+
+<p align="center">
+  <a>
+    <img src="Images/Swager.PNG" alt="Logo">
+  </a>  
+</p>
 
-### 7. Inicialización de Servidor PHP
-Instrucciones para inicializar el servidor PHP y poner en marcha la aplicación localmente.
 
-### 8. Generador de Modelos a través del Yii 2
-Cómo utilizar el generador de modelos proporcionado por Yii 2 para facilitar la creación de modelos de datos.
+Cambiar en el modelo la referencia a nula "Si no se usaran clases tipo Data tranferer object (DTO)"
+<p align="center">
+  <a>
+    <img src="Images/ValorNuloObjetoReferencia.PNG" alt="Logo">
+  </a>  
+</p>
+
+
+Recuerda habilitar el modo cascada para la eliminacion en caso de ser necesario, se puede realizar de muchas maneras por el gestor de microsoft SQL server es una manera de realizarlo
+<p align="center">
+  <a>
+    <img src="Images/cascadaSQL.PNG" alt="Logo">
+  </a>  
+</p>
 
-### 9. Configuración de Controladores
-Instrucciones sobre cómo configurar controladores para gestionar de manera eficiente las solicitudes y respuestas en la aplicación.
 
-### TODO
-Lista de tareas pendientes o mejoras planificadas para el proyecto.
 
-### Tecnologías
-Enumeración de las tecnologías clave utilizadas en el proyecto.
 
-<!-- Otros detalles o secciones del README según sea necesario -->
+PD: Lo pienso migrar a un framework basado en componetes como React
+});