Documentación automática en ASP.NET WebApi y soporte para arquitectura en capas

Buenas!

Como vimos en el post anterior, es muy sencillo el poder tener una documentación automática y detallada de nuestras WebApi’s. Sin embargo, el enfoque propuesto solamente nos sirve cuando todas las clases involucradas están en el mismo proyecto web.

Esto muchas veces no necesariamente es así. En una arquitectura en capas normalmente tendremos un proyecto separado con las clases que representan las entidades del dominio de nuestra aplicación, las cuales formarán parte tanto de requests y responses de la API. Además de que este esquema (con las clases de entidades separadas en otro proyecto) nos permite compartirlas de forma directa (a través de la DLL resultante) a los clientes de la API, por lo cual es una alternativa más que válida para cualquier caso real de implementación.

Veamos el siguiente ejemplo, donde tenemos nuestro proyecto web (WebApi) y una biblioteca de clases con nuestras entidades que interactuan en la API (WebApi.Contracts). En la API tenemos el controlador UsersController que retorna/recibe instancias de User:

DocumentacionWebApiOtrasAssemblies - EstructuraProyecto

Donde la clase User de contratos tiene el siguiente contenido:

Al ejecutar nuestra aplicación e ir a la documentación de la API, veremos que están las propiedades de la clase pero no la documentación que nosotros le hemos agregado:

Leer más »

Anuncios

ASP.NET WebApi: Documentación automática de nuestras API’s

Uno de los puntos importantes en el desarrollo de nuestras API’s RESTfull es tener una documentación adecuada para permitir y facilitar la tarea de integración de distintos clientes. Esto se debe de cierta forma a la diferencia que existe con respecto a un servicio SOAP, donde sí existe un archivo que contiene toda la definición del servicio y se utiliza para su integración.

En el caso de ASP.NET y sus servicios WebApi, esta funcionalidad viene integrada de forma nativa en el proyecto básico de este tipo. Luego de crearlo podremos ver la existencia del área HelpPage, la cual se encarga de crear la estructura de documentación asociada a nuestra API.

WebApiDoc - Area

Si ejecutamos la aplicación veremos en el menú superior el acceso API, el cual nos redirigirá al contenido de esa área.

WebApiDoc - Access

Leer más »

Genymotion, un emulador alternativo y liviano de dispositivos Android

Buenas!!

Cuando trabajamos en el desarrollo de aplicaciones móviles, un punto a tener en cuenta es cómo probarlas, debido a que necesitamos correrlas en un dispositivo con el sistema operativo para el cual estemos haciendo nuestro desarrollo.

En el post anterior vimos una de las alternativas con las que contamos, que son los emuladores disponibles en el Android Virtual Device Manager (o AVD Manager). Esta es la alternativa oficial de Android con la que contamos por defecto. Sin embargo, aunque han ido mejorando en el último tiempo, el rendimiento de los emuladores no es el mejor, necesitando que tengamos un hardware de muy alto nivel o usemos configuraciones de celulares con muy pocos recursos que no son representativos de la realidad que necesitamos emular.

Ante esto contamos con un emulador alternativo, el cual es el que uso a nivel personal: Genymotion. La gran ventaja que nos ofrece es que las imágenes de los dispositivos corren sobre VirtualBox, aprovechando de forma mucho más eficiente los recursos con los que contamos permitiendo probar aplicaciones de forma realmente fluida. Además nos ofrece muchas opciones de personalización sobre la configuración y ejecución del dispositivo, las cuales veremos más adelante. Otro gran punto a favor es que es multiplataforma, por lo cual podremos usarla tanto en Windows, Linux y Mac. Eso si, es gratuita pero siempre para uso personal.

Lo primero que debemos hacer es ir a la página de Genymotion y crearnos un nuevo usuario. Luego de realizado esto accederemos al siguiente link para seleccionar la opción a descargar, pudiendo elegir la versión que cuenta con VirtualBox integrado o la que no lo tiene (esto depende de si ya tenemos VirtualBox instalado en nuestro equipo). Una vez descargado realizamos normalmente la instalación.

Genymotion - Download

Leer más »

Android en Xamarin: Conceptos generales, consideraciones y configuraciones

En el post anterior vimos cómo crear nuestra aplicación con Xamarin.Forms, corriendo en Android una de las aplicaciones target. La idea de este post es explicar cómo configurar el entorno de desarrollo y las consideraciones que tenemos que tener en cuenta sobre la misma.

Para ello hay tres aspectos que debemos tener en cuenta:

  • Dependencias según las versiones de Android que usemos
  • Configuración del proyecto Android en Visual Studio
  • Correr la aplicación en emuladores

Veamos en detalle cada uno de estos puntos:


Android SDK Manager

Esta es una de las partes fundamentales para el desarrollo de aplicaciones Android en general ya que es donde vamos a poder descargar todas las dependencias necesarias para el desarrollo.

Algo que hay que explicar como introducción es que en Android existe un concepto muy importante que son los API Levels, que es lo que habitualmente acostumbramos a mencionar como las diferentes versiones de Android disponibles en general. Actualmente tenemos disponibles los recursos desde la API 7 (Android 2.1) hasta la API 25 (Android 7.1.1). En el Android SDK Manager los distintos recursos se encuentran agrupados por cada API Level disponible, teniendo los siguientes recursos disponibles para descarga:

Leer más »

¿Cómo crear una aplicación Xamarin.Forms?

Buenas!

Continuando con el conjunto de posts asociados a Xamarin vamos a ver cómo crear una aplicación del tipo Xamarin.Forms.

Como hemos mencionado en el post anterior, Xamarin.Forms es la variante de enfoque que nos permite reutilizar código asociado a la lógica de presentación. Con el mismo podremos llegar al extremo (dependiendo del caso es posible de que sea así) de desarrollar solamente una vez el código para múltiples plataformas.

Lo primero que deberemos hacer es crear el tipo de proyecto asociado. Para ello dentro de las opciones para crearlo seleccionamos Cross-Platform > Blank App (Xamarin.Forms portable):

xamarinformsinicial-crearproyecto

Leer más »

Esquemas de reutilización de código en Xamarin

Dentro del desarrollo multiplataforma que plantea Xamarin hay dos puntos claves donde podremos plantear reutilización del código de nuestras aplicaciones: la lógica de negocio y la lógica de presentación. Esto implica que sobre dos de los puntos claves de una aplicación mobile podremos aplicar reutilización de código, reduciendo tiempos de desarrollo y facilitando el mantenimiento.

A su vez estos puntos son complementarios entre sí, pudiendo utilizar ambos de forma simultánea. Lo que si quedará en nuestras manos es la decisión sobre cuando utilizar cada una de estas formas y que funcionalidad tener como compartida entre las distintas plataformas, ya que como en todo desarrollo si planteamos compartir algo que realmente no corresponde nos estaremos complicando sin necesidad.

 

Lógica de negocio:

Este será el punto de reutilización elemental de Xamarin, ya que no hay existe prácticamente escenario donde no sea provechoso reutilizar la lógica de negocio de una aplicación.

A aquellos que ya hayan hecho desarrollos móviles en distintas plataformas, ¿no les ha pasado de que terminan haciendo exactamente la misma lógica de aplicación en distintos lenguajes y con distintos frameworks, resolviendo los mismos problemas pero de distintas formas? Acá está el punto original sobre el cual Xamarin a venido a ayudarnos.

La clave aquí está en desarrollar toda nuestra lógica de aplicación a través de proyectos separados a lo que son las capas de presentación, y desde estás últimas referenciar a dichos proyectos. En los proyectos compartidos donde desarrollemos toda nuestra lógica de aplicación por ejemplo podremos hacer lo siguiente (solo por mencionar algunos usos comunes):

Leer más »

Instalando Xamarin en Visual Studio

Buenas!

Continuando con la introducción ya vista, en este post veremos cómo configurar nuestro entorno de trabajo con Xamarin.

Como ya hemos comentado, Xamarin nos permite crear aplicaciones nativas para cada una de las plataformas a las cuales podríamos llamar líderes del mercado: Android, iOS y Windows (a través de Windows Phone y  Universal Windows Platform, UWP de aquí en adelante). El planteo para realizar esto a nivel componentes a instalar está compuesto de dos partes:

  • Xamarin en si mismo, a través de Visual Studio o Xamarin Studio
  • El SDK de cada plataforma sobre la cual queramos trabajar

En este post nos vamos a enfocar a trabajar desde un entorno de desarrollo en Windows a través de Visual Studio. Esto implica que dejaremos por fuera tanto a Xamarin Studio como a iOS como plataforma target de nuestras aplicaciones, al menos por ahora. Esto se debe a que para ambos casos necesitamos contar con un dispositivo Mac.

Lo primero para destacar es que Xamarin es gratuito desde principios de este año, lo cual implica que lo podemos descargar sin ninguna complicación, y a partir de allí realizar las pruebas que queramos. Esto sin duda es un punto importante que mantiene la línea de Microsoft en estos últimos tiempos, en la cual se deja de lado en varios aspectos el antiguo esquema de licenciamiento constante.

La instalación es Xamarin en sí es muy sencilla y la podremos realizar a través de dos alternativas, las cuales son muy similares:

Leer más »