sábado, 21 de noviembre de 2015

Web Api 2.0

No hay comentarios.:
A continuación vamos a crear una Web API 2, la cual nos sera util para intercambiar datos con otras sitios web o aplicaciones, las apis viene a reemplazar a los pesados XML web service que han ido perdiendo mercado.

Las Web API al ser HTTP pueden verbos get,post, put y delete. 



Creando un nuevo proyecto



Inicie Visual Studio, en el menu File, seleccione New Project en los templates seleccione c# y luego web, Por ultimo seleccionamos  





Se mostrara el cuando de dialogo de new ASP.Net Project, acá seleccionamos Web Api y se marca la caja de selección Web API.






Extrayendo Datos.

Para extraer datos necesitamos crear Modelos, los modelos representas tablas, vistas o resultados  de nuestra base de datos, nosotros tomaremos esos modelos y los vamos a serializar en formato JSON, a continuación vamos a crear la clase de Productos la cual es representativa de la tabla Products.




En el solución explorer, vamos a la carpeta modelo, presionamos clic derecho seleccionamos Add y luego Class, solo vamos a utilizar unos pocos campos. por lo que quedara de la siguiente manera:





<>


using System;
using System.ComponentModel.DataAnnotations;

namespace AppNorthwind.Models
{
    public class Product
    {
        [Key]
        public int ProductID { get; set; }
        public string ProductName { get; set; }
        public Nullable<int> SupplierID { get; set; }
        public Nullable<int> CategoryID { get; set; }
        public Nullable<decimal> UnitPrice { get; set; }
        public Nullable<short> UnitsInStock { get; set; }
    }
}


Configurando el Accedo a la Base de Datos

Vamos a cambiar nuestro web config para que se conecte a la base de datos que necesitamos.

Abre el web config y cambiamos la sección connection string

<connectionStrings>
     <add name="DefaultConnection" 
     connectionString="Data Source=localhost;Initial Catalog=Northwind;user id=sa;password=P@ssw0rd" 
     providerName="System.Data.SqlClient" />
<connectionStrings>

Con este cambio ya podremos alcanzar el servidor de base de datos.

Creando Un Contexto


Necesitamos un contexto que realize el mapeo entre la base de datos y nuestra clase y así se llene cuando los solicitemos.  

Un contexto no es mas que una clase que hereda de context, vamos agregar una nueva clase repitiendo los pasos de la clase productos, solo que ahora le agregaremos el nombre NorthwindContext






La clase NorthwindContext deberia quedar de la siguiente manera:
using System.Data.Entity;
using System.Data.Entity.ModelConfiguration.Conventions;


namespace AppNorthwind.Models
{
    public class NorthwindContext : DbContext
    {
        public NorthwindContext()
            : base("DefaultConnection")
        {
        }

        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
            base.OnModelCreating(modelBuilder);
        }

        public DbSet<Models.Products> Products { get; set; }

    }
}


En el constructor llamamos la conexión agregada en el web config, luego sobre escribimos al void OnModelCreating para evitar que entity framework ponga en plural o singular los nombre de las tablas, ya que queremos que los deje com el mismo nombre, por ultimo agregamos el mapeo de la tabla de la base de datos a nuestra clase Products.

Antes de continuar debemos de compilar el proyecto, en el solucion explorer, en nuestro proyecto (AppNorthwind)  clic derecho build.





Agregando Controladores 

Los controladores nos ayudaran a exponer las llamadas a nuestra API, vamos a usar el concepto de Scaffolding para que nos genere el CRUD luego podemos agregar nuestros metodos de ser necesarios.

Sobre la Carpeta Controller presionamos clic derecho y luego add y por ultimo Controller.




En la ventana de Scaffolding seleccionamos, Web API 2 Contoller with actions, using Entity Framework, esto nos creara las acciones del CRUD.




Ahora nos solicitara que agreguemos nombre a nuestro controlador, y que seleccionemos el modelo y contexto.

Controller: ProductsController
Model: Products
Context: NorthwindContext





Bueno Ahora nos generara nuestro controlador con sus acciones.

Nos creo varias acciones

Accion URL Tipo
GetProducts() api/Products Obtiene (GET)
GetProducts(int id) api/Products/5 Obtiene (GET)
PutProducts(int id, Products products) api/Products/5Cambia (PUT)
PostProducts(Products products) api/Products Guarda(POST)
DeleteProducts(int id) api/Products/5 Borra



Agregando Documentación del API

Vamos a revisar la documentación que ha generado el proyecto, ejecutamos el proyecto con F5 o con el boton run.




Cuando haces clic en las acciones, nos muestra mas detalles.






Probando la API 

Hay varias formas de probar la API, 


1.) Una forma sencilla es hacerlo directamente desde la URL


http://localhost:3548/api/Products/1


http://localhost:3548/api/Products





2.) Vamos a iniciar con una simple pagina.

Agregamos una pagina, hacemos  clic derecho sobre el proyecto y seleccionamos nuevo




Ahora selecciona HTML page, colocamos test.html a nuestra pagina de prueba.




La pagina de prueba debería de quedar así.




<!DOCTYPE html>
<html>
<head>
    <title></title>
 <meta charset="utf-8" />
</head>
<body>
    <div>
        <h2>Producto</h2>
        <input type="text" id="txtcodigo" size="15"  />
        <input type="button" value="Buscar" onclick="find();" />
        <ul id="respuesta" />
    </div>

    <script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-2.0.3.min.js"></script>
    <script>

        function find() {
            var codigo = $('#txtcodigo').val();

            var uri = 'api/products/' + codigo;

            $.ajax({
                type: "GET",
                accept: "json",
                url: uri,
                contentType: "application/json",
                cache: false
            }).done(function (data) {
                $.each(data, function (key, item) {
                    // Add a list item for the product.
                    $('<li>', { text: JSON.stringify(item) }).appendTo($('#respuesta'));
                });
            }).fail(function (data) {
                var x = JSON.parse(data);

                console.log(x);
            });
        }

    </script>
</body>
</html>

Ahora probamos nuestra api, ejecutamos nuestro proyecto con F5


Si quieres probar debes de cambiar url, por ejemplo

 var uri = 'api/products/';


Probando la API con Fiddler

Fiddler es una herramienta que nos ayuda a probar, lo puedes bajar de http://www.telerik.com/fiddler

Aquí una capturas de pantalla que nos mostraran como probarlo.





 Hosting API

Es ideal apagar la pagina Help en producción, para esto abrimos el archivo Global.asas y comentamos la linea  AreaRegistration.RegisterAllAreas 

protected void Application_Start()
        {
            //AreaRegistration.RegisterAllAreas();
            GlobalConfiguration.Configure(WebApiConfig.Register);
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);
        }

Para que no se muestre el link de api, quite el link de  View --> Share --> _Layout.cshtml

Si piensan hacer hosting de ese proyecto, como el proyecto esta en framework 4.5.2 el .net 2015 agrega soporte para c# 6 y nos agrega una carpeta llamada roslyn donde tiene los exe CSC y VBC los cuales hosting como winhost, godaddy no lo soportaran, por lo que es mejor quitarlo.

En el menu tools, NuGet Package Manager --> package manager Console



En la consola ejecutamos:


PM> uninstall-package Microsoft.CodeDom.Providers.DotNetCompilerPlatform  
PM> uninstall-package Microsoft.Net.Compilers  



Si tiene mas problemas con roslyn vean esta link. Removing roslyn from ASP.NET


Ver