Creando una API RESTful con documentación sobre Azure App Service.

Introducción 

La plataforma de Azure provee un vasto set de capacidades dentro de un modelo de Plataforma como servicio (PaaS) para alojar aplicaciones web y servicios. La plataforma es capaz de ofrecer algo más que solo alojar para ejecutar la lógica en sus aplicaciones; esta también incluye una serie de robustos mecanismos para gestionar todos los aspectos acerca del ciclo de vida de su aplicación web como servicios web respectivamente. 

Azure App Services incluye un numero de características para gestionar sus aplicaciones web y servicios incluyendo Web Apps, Logic Apps, Mobile Apps y API Apps.  De esta manera hacemos introducción para explicar mediante este articulo con un breve ejemplo el uso de estas características para alojar en este caso específico una web API RESTful de manera muy sencilla y en adición a una documentación robusta y dinámica. 

Estas características claves son de primordial importancia para la creación de aplicaciones web modernas a través de la nube de Azure como (PaaS). 

Cuando usted está en el proceso de diseño de una arquitectura de software basada en una aplicación web, una de las capas que necesitara implementar es una API lo cual permite que las capas de su arquitectura puedan comunicarse con cada una de las demás. Independientemente de la arquitectura de su aplicación, esta es una buena oportunidad para que implemente una API RESTful para que dicha intercomunicación suceda con su respectiva documentación para el uso de su API. 

Luego de leer este articulo usted podrá: 

  • Crear una aplicación API RESTful sobre Azure App service. 
  • Crear una documentación bien estructurada para la API utilizando herramientas de código abierto. 

Crear una aplicación API con Azure App Service es un poco similar a crear una aplicación web normal desplegada como un App service. Usted podrá tener las mismas opciones disponibles para su aplicación API que usted tiene para una aplicación web normal. 

Crear e implementar una aplicación API 

Para crear una aplicación API RESTful en Azure App Service existen muchas formas, las maneras más comunes son ya sea mediante el portal de Azure o directamente desde Visual Studio, en este caso vamos a realizar el ejemplo desde Visual Studio 2019: 

  1. Ejecute Visual Studio 2019 y seleccione en la opción Archivo > Nuevo > Proyecto. 
  1. En la ventana emergente de Nuevo Proyecto, seleccione ASP.NET Web Application (.Net Framework) dentro de la categoría de Cloud y haga clic en Siguiente. 
  1. En la ventana emergente de configuración del Nuevo Proyecto, escriba el nombre del proyecto, en la ubicación física en el disco seleccione el tipo de framework .NET a utilizar y luego haga clic en Crear. 
  1. Seleccione la plantilla de Web API en la ventana emergente de configuración de nuevo proyecto y luego haga clic en Crear. 

De esta manera Visual Studio crea un nuevo proyecto web API con la siguiente estructura de archivos en el árbol de archivos en el explorador de la solución: 

Generar la documentación automática de la API usando Swashbuckle 

Swashbuckle es un framework de código abierto muy popular que consiste en un gran ecosistema de herramientas que funcionan para diseñar, construir, documentar, y consumir su RESTful API, lo que lo vuelve la alternativa ideal para crear la documentación de la API de manera más automatizada, el paquete de NuGet está muy bien documentado así que pueden revisar la documentación para más detalles accediendo al proyecto GitHub accediendo al final del artículo. 

Swashbuckle se proporciona a través de un conjunto de paquetes de NuGet: Swashbuckle y Swashbuckle Core. A continuación, siga estos pasos para agregar Swashbuckle a su proyecto de API: 

  1. Instale el paquete de NuGet, lo cual incluye Swashbuckle.Core como una dependencia al momento de instalar usando el siguiente comando desde la consola de paquetes de Nuget: 
Install-Package Swashbuckle 
  1. El paquete de NuGet también instala un archivo de arranque inicial o bootstrapper (App_Start/SwaggerConfig.cs) lo cual habilita las rutas de Swagger al iniciar la aplicación API usando WebActivatorEx. Usted también puede configurar las opciones de Swashbuckle modificando el método de extensión GlobalConfiguration.Configuration.EnableSwagger en el archivo SwaggerConfig.cs. también puede excluir de su API las acciones que han sido marcadas con el decorativo de obsoletas agregando la siguiente configuración: 
public class SwaggerConfig 
{ 
        public static void Register() 
        { 
            var thisAssembly = typeof(SwaggerConfig).Assembly; 
  
            GlobalConfiguration.Configuration 
              .EnableSwagger(c => 
              { 
                ...  
                ... 
              //Set this flag to omit schema property descriptions    for any type properties decorated with the Obsolete attribute 
                      
                c.IgnoreObsoleteProperties(); 
 
               ... 
               ... 
         }); 
      } 
 } 
  1. Modifique las acciones de los controladores en su proyecto API para incluir el atributo swagger para ayudar al generador a construir los metadatos de swagger. 
  1. Swashbuckle está ahora configurado para generar los metadatos Swagger para los endpoints de su API con una simple interfaz de usuario para explorar la metadata. Por ejemplo, el controlador que se lista puede producir la UI que se muestra bastando solo con escribir Swagger en la barra del navegador web seguido de la url de la aplicación web.  

Publicar la API RESTful en Azure App Service 

Hasta este punto ya tenemos el diseño de una API con lo básico para conectar con las demás capas de su proyecto, también contamos con una documentación que ya se genera de manera automática, aprovechando al máximo toda la metadata y definición de su API a través de las acciones de sus controladores, ya preparado lo anterior mencionado hasta este momento para implementar su aplicación API se necesita completar la publicación desde Visual Studio hacia Azure App Service para desplegar su proyecto API en la nube. 

Siga estos pasos para desplegar su proyecto API desde Visual Studio: 

  1. Haga clic derecho sobre el proyecto en el Visual Studio Solution Explorer y luego hacer clic en Publicar.
  1. En la ventana de dialogo de publicación, seleccione en App Service en la parte izquierda superior, luego Crear Nuevo, posteriormente hacer clic en publicar para ir a la configuración de App Service de Azure.

  1. La ventana cambiara y lo enviara a una configuración más específica donde primeramente debe de escribir el nombre de la aplicación a desplegar en Azure App Services, luego seleccione la suscripción a la cual está asociado en su portal de Azure. 
  1. A continuación, se debe de especificar un grupo de recurso dentro de la nube de Azure al cual se va a asignar la aplicación web API como recurso de Azure App Service. 
  1. En el caso de que no posea ningún recurso o quiera crear un nuevo recurso haga clic en nuevo nombre de grupo de recurso a crear. 
  1. Este grupo de recurso por lo general asigna una capacidad de gasto calculado a través de un plan de hosting escalable con más o menos capacidades como lo son por ejemplo uso de RAM o número de procesadores necesarios para la ejecución del API, lo cual por defecto selecciona S1 (1 core, 1.75 GB RAM), en este caso le vamos a bajar escalabilidad del API para efectos de prueba y seleccionamos un plan de costos gratuito, este por ser compartido y además por ser un ambiente inicial de pruebas, cuando ya se quiera escalar más la aplicación o cambiar a un ambiente de más calidad y/o producción se puede optimizar a un plan adecuado para ejecutar de manera eficiente su proyecto API. 
  1. Una vez configurado todo el entorno del proyecto API en Azure App Service, se crea un perfil de publicación en Visual Studio para que cada vez que quiera ejecutar un despliegue de su API con cambios nuevos simplemente le damos a ejecutar la publicación mediante el botón Publicar. Visual Studio procede a compilar e intentar subir todos los archivos del proyecto API hacia la nube de Azure mediante Azure App service, de esta manera ya puede acceder a su API a través de la internet. 
  1. Cuando la publicación de su proyecto API esté finalizado, este abrirá en una nueva ventana de navegador donde se mostrará la página web inicial de publicación. 
  1. Navegaremos hacia la documentación Swagger a través de la ruta /Swagger para ver los detalles de la documentación de la API, además para probar los métodos REST ya expuestos mediante la API. Por ejemplo, http://<SU-API-APP&gt;.azurewebsites.net/swagger/ 

De esta manera ya podemos contar con una aplicación RESTful con una documentación bien estructurada de manera automatizada debidamente ejecutándose a través de la nube de Azure mediante Azure App Service. 

Código fuente 

https://github.com/hughfernandez/API-RESTfull-Demo-Doc-Swagger

Microsoft .NET Framework 4.8

Estamos encantados de anunciar el lanzamiento de .NET Framework 4.8. Se incluye en la actualización de Windows 10 de mayo de 2019. .NET Framework 4.8 también está disponible en Windows 7+ y Windows Server 2008 R2 +.

Puede instalar .NET 4.8 desde nuestro sitio de descarga .NET. Para crear aplicaciones dirigidas a .NET Framework 4.8, puede descargar NET 4.8 Developer Pack. Si solo desea el tiempo de ejecución de .NET 4.8, puede probar:

.NET 4.8 Web installer: requiere una conexión a Internet durante la instalación.
 .NET 4.8 Offline installer: se puede descargar e instalar más tarde en un estado desconectado.

Mejoras en la versión

.NET Framework 4.8 incluye un conjunto de herramientas actualizado, así como mejoras en varias áreas:

     [Tiempo de ejecución] Mejoras JIT y NGEN
     [BCL] ZLib actualizado
     [BCL] Reducción del impacto de FIPS en la criptografía
     [WinForms] Mejoras de accesibilidad
     [WCF] Mejoras de comportamiento del servicio
     [WPF] Mejoras de alta DPI, Mejoras de automatización UIA

Puede ver la lista completa de mejoras en las notas de la versión de .NET Framework 4.8. Las fuentes de referencia también se han actualizado para .NET 4.8.

Versiones de Windows compatibles

Versiones de cliente de Windows: Windows 10 versión 1903, Windows 10 versión 1809, Windows 10 versión 1803, Windows 10 versión 1709, Windows 10 versión 1703, Windows 10 versión 1607, Windows 8.1, Windows 7 SP1
Versiones de Windows Server: Windows Server 2019, Windows Server versión 1803, Windows Server 2016, Windows Server 2012, Windows Server 2012 R2, Windows Server 2008 R2 SP1

Pruebe estas mejoras en .NET Framework 4.8 y comparta sus comentarios en los comentarios a continuación o a través de GitHub.

¡Gracias!

Como enviar un objeto con imagen por POST hacia un WebAPI en formato JSON

Sabemos que Json está revolucionando la programación hoy en día. XML ya empieza a irse desplazando de un tiempo para acá, mucho auge de tecnologías basadas en motores de JavaScript pero bueee la tecnología es así….

Este código es bien sencillo, por lo tanto en este artículo solo voy a hacer énfasis en ese fragmento de código, por lo que no voy a explicar otras cosas alrededor, la idea es poder tener la lógica en nuestras apps y que puedas incorporar esta funcionalidad tan vital para aplicaciones que interactúan mucho con imágenes o alguna captura de multimedios.

Previo a realizar esta subida de data hacia un servidor se debe de tener una WebApi, las WebAPIs son lo más sencillo y dinámico para exponer información, ya sea de un repositorio de data, así como la misma establece una capa de datos muy dinámica y portable por ser multiplataforma.

Ya teniendo tu propia WebAPI arriba en algún servidor (Azure, IIS, etc), se debe de crear una aplicación cliente que consumirá información y podrá hacer peticiones, sencillamente estamos trabajando en C#, ya sea un app Winform, WPF, Xamarin, UWP . También necesitamos la librería Json.Net que la puedes conseguir en Nuget

Volviendo al código tenemos:

public void UploadData(byte[] imagen) //recibimos la imagen como parametro en el metodo
{
  using (var client = new HttpClient())
  {
    var objetoClase1 = new ObjetoClase()
    {
      ID = Guid.NewGuid(),
      MediaStream = imagen, //esta es la imagen representada en Byte[]
      Description = "dummy";
    };
//La magia esta aqui
    var response = await client.PostAsync(new Uri("URL del WebAPI"), new HttpStringContent(JsonConvert.SerializeObject(objetoClase1), UnicodeEncoding.Utf8, "application/json"));

    if (response.IsSuccessStatusCode)
    {
    //Al entrar aqui es porque el POST hacia el webAPI fue exitoso (Codigo 200:OK)
    }
}
}

Espero les sea de utilidad.
Enjoy….

Web Camps de Microsoft para este año…





Los Web Camps de Microsoft de 1 solo dia son una versión más pequeña de los eventos más grandes que son normalmente de 2 días.



Estos Web Camps te permiten
aprender y construir sitios web con ASP.NET, MVC, WebMatrix, OData y mucho más. Estos eventos cubrirá 1 de los 3 temas e incluirá presentaciones y el manejo del desarrollo de estas tecnologias. Más eventos vienen y se añadirá a la lista de abajo tan pronto como las fechas se confirman.

Esta es la lista de los países adicional que será el anfitrión de los campos de Web de este año: Argentina, Bélgica, Brasil, Canadá, Chile, Finlandia, Indonesia, Israel, Países Bajos, Nueva Zelanda, Noruega, Portugal, España, Tailandia, Turquía, Emiratos Árabes Unidos, el Reino Unido y los EE.UU. Este y Central.

para mas informacion siguelos en Twitter @Webcamps

Ciudad Pais
Fecha Tecnologia Link Registro

Caracas Venezuela 25-Jan-11 ASP.Net MVC Register Here
Maracaibo Venezuela 26-Jan-11 ASP.Net MVC Register Here
Porlamar Venezuela 28-Jan-11 ASP.Net MVC Register Here
Tunis Tunisia 1-Feb-11 ASP.Net MVC Register Here
Istanbul Turkey 1-Feb-11 WebMatrix Register Here
Montreal Canada 5-Feb-11 ASP.Net MVC Register Here
Calgary Canada 5-Feb-11 ASP.Net MVC Register Here
Jeddah Saudi Arabia 15-Feb-11 WebMatrix Register Here
Jeddah Saudi Arabia 16-Feb-11 WebMatrix Register Here
Toronto Canada 19-Feb-11 ASP.Net MVC Register Here
Riyadh Saudi Arabia 22-Feb-11 WebMatrix Register Here
Riyadh Saudi Arabia 23-Feb-11 WebMatrix Register Here
Mountain View, CA USA 26-Feb-11 ASP.Net MVC Register Here
Des Moines, IA USA 17-Mar-11 WebMatrix Register Here
Bad Homburg Germany 23-Mar-11 WebMatrix Register Here
Redmond USA 25-Mar-11 ASP.Net MVC Register Here
Ottawa Canada 26-Mar-11 ASP.Net MVC Register Here
Munich Germany 31-Mar-11 WebMatrix Register Here
Moulineaux France 5-Apr-11 TBA Register Here
Nashville, TN USA 27-Apr-11 WebMatrix Register Here
Columbus, OH USA 29-Apr-11 WebMatrix Register Here
Dallas, TX USA 16-May-11 WebMatrix Register Here
Moulineaux France 17-May-11 TBA Register Here
Little Rock, AR USA 18-May-11 WebMatrix Register Here
St. Louis, MO USA 20-May-11 WebMatrix Register Here
Minneapolis, MN USA 24-May-11 WebMatrix Register Here
Milwaukee, WI USA 25-May-11 WebMatrix Register Here
Southfield, MI USA 2-Jun-11 WebMatrix Register Here
Tulsa, OK USA 2-Jun-11 WebMatrix Register Here
Irvine, CA USA 10-Jun-11 ASP.NET MVC Muy Pronto
Moulineaux France 14-Jun-11 TBA Register Here

Por otro lado Proximamente se celebrara en un WebCamps en Porlamar donde estare presente y mi compañero de trabajo @ernesth tendra una gran y exelente ponencia sobre Jquery donde veremos el poder de esta tecnologia en la web….vamos ernesto esperamos una gran charla y buena vibra con este gran tema…

Nos vemos en el WebCamps el 28 de enero muchachos… 😀