Consumir una API con jQuery y AJAX

En este post intentaremos aprender a consumir una API con jQuery y AJAX.

Nota: en el ejemplo que vamos a desarrollar partimos con que nuestro servicio API se encuentra en la misma web donde vamos a desarrollar el cliente.

Partimos también con que existen dos métodos en la API: obtención de una lista de todos los productos (URI: ”/api/products”) y seleccionar un producto por un identificador (URI: ”/api/products/id“). La URI podrá cambiar dependiendo donde se ubique el servicio… en muchos casos puede ser del tipo “http://…”

Usaremos jQuery para realizar llamadas AJAX y actualizar la página con los resultados.

Empezamos por crear nuestro archivo vacío HTML. En él escribiremos lo siguiente:

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
 <title>Product App</title>
</head>
<body>

<div>
 <h2>All Products</h2>
 <ul id="products" />
 </div>
 <div>
 <h2>Search by ID</h2>
 <input type="text" id="prodId" size="5" />
 <input type="button" value="Search" onclick="find();" />
 <p id="product" />
 </div>

<script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-2.0.3.min.js"></script>
 <script>
 var uri = 'api/products';

$(document).ready(function () 
 // Send an AJAX request
 $.getJSON(uri)
 .done(function (data) 
 // On success, 'data' contains a list of products.
 $.each(data, function (key, item) 
 // Add a list item for the product.
 $('<li>', text: formatItem(item) ).appendTo($('#products'));
 );
 );
 );

function formatItem(item) 
 return item.Name + ': $' + item.Price;
 

function find() 
 var id = $('#prodId').val();
 $.getJSON(uri + '/' + id)
 .done(function (data) 
 $('#product').text(formatItem(data));
 )
 .fail(function (jqXHR, textStatus, err) 
 $('#product').text('Error: ' + err);
 );
 
 </script>
</body>
</html>

Nota: Existen muchas maneras de obtener jQuery, en este caso lo obtenemos de un recurso compartido en Internet (http://ajax.aspnetcdn.com/ajax/jQuery/jquery-2.0.3.min.js)

Obtener la lista de productos

Para obtener la lista de productos se envía una petición HTTP (GET) a la uri donde se encuentra el servicio API. (/api/products).

La función de jQuery getJSON envía una petición asíncrona AJAX. La respuesta esperará por tanto un array de objetos JSON.  La función “done” especifica que la respuesta ha llegado. Cuando llegue la respuesta actualizaremos el DOM con la información que hemos recibido.

$(document).ready(function () 
 // Send an AJAX request
 $.getJSON(apiUrl)
 .done(function (data) 
 // On success, 'data' contains a list of products.
 $.each(data, function (key, item) 
 // Add a list item for the product.
 $('<li>', text: formatItem(item) ).appendTo($('#products'));
 );
 );
);

Obtener un elemento pasando un identificador

Para obtener un producto por un un identificador, enviaremos un petición HTTP GET a “/api/products/id“, donde id es el identificador de producto.

function find() 
 var id = $('#prodId').val();
 $.getJSON(apiUrl + '/' + id)
 .done(function (data) 
 $('#product').text(formatItem(data));
 )
 .fail(function (jqXHR, textStatus, err) 
 $('#product').text('Error: ' + err);
 );

Consumir una API con jQuery y AJAX

Programar una API con ASP.NET

Como sabemos el protocolo HTTP no sirve únicamente para servir páginas Web sino que también puede actuar como APIs que exponen servicios y datos. Estos servicios pueden ser consumidos por una gran cantidad de clientes como pueden ser navegadores, aplicaciones de escritorio, etc.

Crear un proyecto ASP.NET Web API

Centrándonos un poco más en ASP.NET, con Visual Studio 2013 existe la posibilidad de crear de una manera extremadamente fácil un proyecto API. Se hará a través de una plantilla.

Nuevo proyecto Web

Asignar plantilla Web API a la creación del proyecto

Gracias a esta plantilla Visual Studio nos creará automáticamente un esqueleto que nos permitirá poder añadir elementos de servicio que darán funcionalidad a nuestra API. En la anterior imagen creamos un proyecto vacío pero si nos fijamos también hemos marcado más abajo que queremos que nos añada los directorios y las referencias necesarias en el proyecto.

Como siempre las cosas se pueden hacer de distintas maneras… en este caso también se puede afrontar la creación de la API con MVC. En nuestro caso continuaremos sin utilizar MVC.

Añadir  un modelo

A continuación añadiremos un modelo. El modelo es un objeto que representa los datos de tu aplicación. ASP.NET Web API puede serializar automáticamente tu modelo a JSON, XML o cualquier otro formato y entonces escribir los datos serializados dentro del cuerpo de la respuesta HTTP. Además el cliente siempre puede indicar que formato quiere fijando la cabecera en la petición del servicio.

En este ejemplo añadiremos un modelo que represente un producto. Para ello haremos click derecho encima de la carpeta Models y añadiremos una clase.

Nombraremos la clase como “Product” y escribiremos el siguiente código:

namespace ProductsApp.Models

 public class Product
 
 public int Id get; set; 
 public string Name get; set; 
 public string Category get; set; 
 public decimal Price get; set; 
 

Añadir un controlador

En Web API, un controlador es un objeto que maneja peticiones HTTP. Añadiremos un controlador que devuelva una lista de productos o un único producto especificado por un Identificador.

Para añadir un controlador haremos click derecho sobre el directorio “Controllers” dentro de la solución y seleccionaremos “Controller”.

En la nueva ventana elegiremos Web API Controller – Empty. Pulsaremos añadir.

Le podremos llamar “ProductsController” por ejemplo. Insertaremos el siguiente código dentro de este fichero:

using ProductsApp.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Web.Http;

namespace ProductsApp.Controllers

 public class ProductsController : ApiController
 
 Product[] products = new Product[]
 
 new Product Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1 ,
 new Product Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M ,
 new Product Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M 
 ;

public IEnumerable<Product> GetAllProducts()
 
 return products;
 

public IHttpActionResult GetProduct(int id)
 
 var product = products.FirstOrDefault((p) => p.Id == id);
 if (product == null)
 
 return NotFound();
 
 return Ok(product);
 
 

Si nos fijamos existen 2 métodos: GetAllProducts y GetProduct. Gracias a ASP.NET Web API podremos acceder a cada uno de estos métodos a través de las siguientes URIs: /api/products y /api/products/id.

Como vemos es muy sencillo programar una API con ASP.NET. En otro post hablaremos de cómo se puede consumir un servicio de este tipo con AJAX y jQuery.

Programar una API con ASP.NET

Error en owin al renombrar proyectos

Si renombramos un proyecto o varios de ellos en una aplicación web y estamos utilizando Owin es posible que aparezca el siguiente error:

The following errors occurred while attempting to load the app.

- The OwinStartup attribute discovered in assembly ‘x’ referencing startup type ‘x.Startup’ conflicts with the attribute in assembly ‘y’ referencing startup type ‘y.Startup’ because they have the same FriendlyName ”. Remove or rename one of the attributes, or reference the desired type directly.

To disable OWIN startup discovery, add the appSetting owin:AutomaticAppStartup with a value of “false” in your web.config.

To specify the OWIN startup Assembly, Class, or Method, add the appSetting owin:AppStartup with the fully qualified startup class or configuration method name in your web.config.

Este error se suele producir porque existen dos ensamblados cargados en nuestra carpeta bin de la solución que contiene una clase startup. En la ejecución de la aplicación asp.net no sabe resolver cual de las dos clases debe ejecutar y de ahí el error.

La solución es ir a la carpeta bin y borrar la dll antigua que ya no es necesaria.

Error en owin al renombrar proyectos

Recargar página automáticamente mediante la intrucción Meta refresh

Igual no es una instrucción muy conocida (o al menos yo no la conocía hasta ahora) pero existe una opción en html para indicar al navegador que la página se refresque pasado un cierto número de segundos.

Esta instrucción se representa mediante la etiqueta meta y se debería insertar dentro de la etiqueta <head> aunque en algunos casos pueda funcionar fuera de ella:

...

<header>

<META http-equiv=refresh content=10>

...

En el ejemplo anterior le estamos diciendo que la página se refresque automáticamente cada 10 segundos.

Existe la opción de indicarle al navegador que pasados un cierto número de segundos debe redirigir a una url especificada. En el siguiente ejemplo haremos que el navegador vaya a la url: “pagina.com” pasados 5 segundos.

<meta http-equiv="refresh" content="5; url=http://pagina.com/">

En este otro ejemplo que aparece a continuación le indicamos que redirija a la url “pagina.com” inmediatamente asignando a content el valor 0.

<meta http-equiv="refresh" content="0; url=http://pagina.com/">

Esta es una manera bastante elegante de recargar página automáticamente únicamente con html. Lógicamente existen otras maneras como pueden ser scripts realizados en javascript, php, asp, etc…

Recargar página automáticamente mediante la intrucción Meta refresh

Hacer un Response de cualquier tipo de contenido dentro de un UpdatePanel

Cuando trabajamos con UpdatePanel en ASP existe la posibilidad de que no se pueda realizar una respuesta de cualquier tipo de contenido sin realizar un postback.

Por ejemplo: creación de un fichero xls o xlsx de Excel.

...

HttpContext.Current.Response.ContentType = "application/ms-excel";

...

Si el control que hace de trigger se encuentra dentro del mismo updatepanel es muy posible que sea necesario indicar en el script que dicho control desencadenará el evento.

<asp:UpdatePanel runat="server" ID="upPanel">

<Triggers>

<asp:PostBackTrigger ControlID="btnTrigger" />

</Triggers>

...

</asp:UpdatePanel>

Hacer un Response de cualquier tipo de contenido dentro de un UpdatePanel

Notificar una excepción manualmente a ELMAH

Si trabajamos con ELMAH y realizamos nuestro propio control de errores será necesario notificarle que queremos que guarde esa excepción controlada. Lo haremos con:

ErrorSignal.FromCurrentContext().Raise(ex);

Notificar una excepción manualmente a ELMAH

Como crear un Theme en ASP NET

Para crear un Tema o Theme en Visual Studio debemos hacer click derecho sobre el proyecto web y añadir la carpeta de ASP.NET App_Themes . Nos pedirá un nombre, le daremos el nombre MainTheme por ejemplo.

Una vez creado este directorio especial podemos añadirle dentro de sí un nuevo item de extensión .Skin.

Lo último que nos queda es especificar en el web.config la theme que usará el sitio por defecto.

<configuration>
 <system.web>
<pages theme="MainTheme">

</pages>

</system.web>

</configuration>

Ya estará funcionando nuestro tema, solo quedaría definir en nuestro skin las propiedades de cada control.

Como crear un Theme en ASP NET