sábado, 27 de junio de 2020

API REST .Net Core primeros pasos

API REST .Net Core

Para crear un proyecto api desde Microsoft Visual Studio Community 2019 primero tenemos que descargar e instalar la versión que es totalmente gratuita.

Archivo  Nuevo Proyecto

Seleccionamos “Apicación web ASP.NET Core” y le damos en siguiente



Establecemos el nombre del proyecto la ubicación y el nombre de la solución, en seguida seleccionamos crear.







Seleccionamos la opción API y damos clic en crear.


Cuando se crea el proyecto lo vas a visualizar más o menos de esta forma en tu IDE.



Te describo las carpetas y Archivos que se presentan

En la carpeta Controllers se tiene los controladores donde entraran las solicitudes http por medio de verbos Get, Post, Put y Delete, cada uno de estos están pensados y documentados para realizar una acción especifica en el servicio.

Get se utiliza para obtener datos a través del servicio. Es decir, con operaciones SQL Select
Post se utiliza para insertar datos a través del servicio. Es decir, con operaciones SQL Insert
Put se utiliza para actualizar datos a través del servicio. Es decir, con operaciones SQL Update
Delet se utiliza para eliminar datos a través del servicio. Es decir, con operaciones SQL Delete
Aunque esto está definido así, no necesariamente esto ocurre ya puedes hacer cualquiera de estas operaciones en el Post, pero la formalidad indica lo arriba descrito. Como dato adicional el GET, el PUT y DELETE reciben un ID del elemento que se va a operar de acuerdo con lo descrito










Para agrega un controlador hacemos los siguiente seleccionamos la carpeta Controller y damos clic secundario nos mostrara el menú, seleccionamos agregar y después controlador.



Se mostrará la siguiente pantalla donde vamos a elegir Controlador de API con acciones de lectura y escritura para este ejemplo.

Por convención todos los controladores deben tener el sufijo Controller tal como se muestra en la imagen “El_nombre_de_tu_controlador” + Controler en este caso yo lo nombre como  MyController después da clic en Agregar




Hasta este punto ya puedes ejecutar tu proyecto e invocar a tu controlador. El código generado queda de la siguiente manera. Como podrás ver ya tienes los métodos de Get,  Get/id, Post, Put y Delete ejecuta con F5


Para probar tu api utiliza postman o instala en Chrome json es un plugin que te ayudara a probar tu servicio.

Tienes que colocar la url que te asigna Visual Studio, más api/nombre_del_controlador pero sin el sufijo es decir el controlado quedaría más o menos así localhost:44396/api/My y como podrás ver ya te regresa un valor que esta establecido por default en el controlador en el método Get.

 


Desde JaSON queda como la siguiente imagen, como podrás observar después de la url tiene el método este te permitirá controlar a que operación entra desde ahí puede ser get,post,put o delete.
Para el post la información la deberás mandar en formato json {nombre: valor} para más información investiga sobre Json.



















 Bueno esto es lo básico de ahí seguirá agregar una carpeta para el modelo de datos, una capeta de servicios para el acceso a la DB, tal vez una carpeta de reglas de negocio que operen sobre el modelo antes de ser enviado al servicio.

Otros archivos importantes en el proyecto son:
appsettings.json ahí puedes configurar la cadena de conexión a tu base de datos entre otras configuraciones
https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-3.1

Startup.cs ahí configuraras y darás de alta como servicios algunas cosas por ejemplo el datacontext si vas a usar Entity framework, Json entre otras.
https://docs.microsoft.com/en-us/aspnet/core/fundamentals/startup?view=aspnetcore-3.1


launchSettings.json configuración de como tu aplicación debe iniciar en diferentes escenarios.
https://docs.microsoft.com/en-us/aspnet/core/security/authentication/windowsauth?view=aspnetcore-3.1&tabs=visual-studio


API REST .Net Core primeros pasos

API REST .Net Core Para crear un proyecto api desde Microsoft Visual Studio Community 2019 primero tenemos que descargar e instalar la ver...