Introdu��o ao ASP.NET Web API

Atualmente vemos aplicaç�es web com interfaces realmente ricas como Google Docs, Gmail entre outras, estas aplicaç�es s�o conhecidas como SPA - Single Page Applications, as quais possuem uma �nica p�gina para a aplicaç�o, com o objetivo de melhorar muito a experi�ncia do usu�rio, sem reloads de toda a p�gina levando a uma responsividade como de aplicaç�es desktop.

Este tipo de aplicaç�o tem por caracter�stica um maior processamento de informaç�es no pr�prio browser e utilizaç�o de Ajax para atualizaç�o pontual de partes da aplicaç�o. Este cen�rio � o contr�rio do predominante hoje, que � o de processar toda (ou a grande maioria) da informaç�o no servidor, e s� enviar ao cliente o HTML gerado, ou seja, o browser começa a ter uma import�ncia maior, pois parte do processamento agora � realizado no lado cliente.

Partindo deste cen�rio, vamos estudar hoje uma tecnologia recentemente lançada pela Microsoft chamada ASP.NET Web API. Este Framework nos possibilita a criaç�o e disponibilizç�o de serviços HTTP para que os mesmos possam ser consumidos por browsers e dispositivos m�veis.

Portanto, os pilares para a criaç�o de aplicaç�es ricas est�o formados, Javascript com Ajax, CSS e HTML na parte client e no nosso caso, ASP.NET Web API disponibilizando informaç�es do Server.

O que � ASP.NET Web API?

Web API � um framework para construir serviços HTTP sobre o .Net Framework.

Onde encontrar?

O ASP.NET Web API vem com o ASP.NET MVC 4 e pode ser baixado a partir deste link. Ou para quem j� tem o Visual Studio 2012 este j� vem instalado.

Curso relacionado: Curso de ASP.NET Web API

Para que serve?

Expor serviços via HTTP e possibilitar uma ampla gama de dispositivos (browser, mobile) acess�-los e consumi-los de forma direta.

J� que vimos as noç�es b�sicas, vamos fazer nossa primeira aplicaç�o ASP.NET Web API.

Utilizando o Visual Studio 2012:

Selecione New Project/Asp.Net MVC 4/Web API

Ao criar o novo projeto, repare que temos na Solution explorer a estrutura de um projeto Asp.Net MVC, com views, models e etc por�m perceba que em controllers temos 2 arquivos:
- HomeController, controller padr�o Asp.Net MVC
- ValuesController, este representa um exemplo de Controller Web API.
No entanto, n�o vamos utilizar o ValuesController, vamos exclu�-lo para criarmos um Web API controller vinculado ao Model.
Portanto, vamos criar um Model para representar nossa regra de neg�cio. O ASP.NET Web API serializa automaticamente nosso model/dom�nio para JSON ou XML, permitindo assim que browsers consigam deserializar estes objetos.

Criaremos uma classe Livro da seguinte forma:

Clique com o bot�o direito na pasta Models e posteriormente em Add Class.

Listagem 1: Classe Livro

public class Livro
      {
      public int Id { get; set; }
      public string Nome { get; set; }
      public string Categoria { get; set; }
      public decimal Preco { get; set; }
      }

Com o model criado, vamos criar o Controller, para tanto, clique com o bot�o direito na pasta Controllers e selcione Add Controller...

Figura 1: Adicionando um controller

Selecione na drop down de template "Empty API Controller".

Figura 2: Definiç�o do novo controller

Ao criar o controller, podemos ver que este herda de ApiController, ou seja, n�o herda da classe Controller como um controller padr�o Asp.net MVC.

Na Web API Controller rec�m criada, vamos implementar a seguinte classe que ter� m�todos/serviços que poder�o ser acessados posteriormente.

Listagem 2: Classe LivroController


      public class LivroController : ApiController
      {
      //Livros dummys para teste
      Livro[] livros = new Livro[]
      {
      new Livro { Id = 1, Nome = "Livro 123", Categoria = "Sci-Fi", Preco= 45.60M },
      new Livro { Id = 2, Nome = "Livro 456", Categoria = "Drama", Preco = 23.75M },
      new Livro { Id = 3, Nome = "Livro 789", Categoria = "Aç�o", Preco = 19.90M }
      };
      public IEnumerable<Livro> GetAllLivros()
      {
      return livros;
      }
      public Livro GetLivroById(int id)
      {
      var livro = livros.FirstOrDefault((p) => p.Id == id);
      if (livro == null)
      {
      var resp = new HttpResponseMessage(HttpStatusCode.NotFound);
      throw new HttpResponseException(resp);
      }
      return livro;
      }
      public IEnumerable<Livro> GetLivrosByCategory(string categoria)
      {
      return livros.Where(
      (p) => string.Equals(p.Categoria, categoria,
      StringComparison.OrdinalIgnoreCase));
      }
      }

Criamos uma lista dummy de Livros para representar nossa lista, por�m em uma aplicaç�o real teriamos toda a camada de acesso a dados.

Muito bem, temos agora m�todos que ser�o acessados via API, da seguinte forma:

localhost:porta/api/livros
localhost:porta/api/livros/id
localhost:porta/api/livros/?categoria = categoria

Vamos Testar! pressione F5 e veremmos a p�gina index da aplicacao. Para testar a web API chamaremos da seguinte forma: http://localhost:4726/api/livro (troque o endereco e porta para a do seu teste).

Como resposta obteremos:

Listagem 3: Resposta da chamada � Web API

<ArrayOfLivro xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
      xmlns="http://schemas.datacontract.org/2004/07/WebApiTeste.Models">
      <Livro>
      <Categoria>Sci-Fi</Categoria>
      <Id>1</Id>
      <Nome>Livro 123</Nome>
      <Preco>45.60</Preco>
      </Livro>
      <Livro>
      <Categoria>Drama</Categoria>
      <Id>2</Id>
      <Nome>Livro 456</Nome>
      <Preco>23.75</Preco>
      </Livro>
      <Livro>
      <Categoria>Aç�o</Categoria>
      <Id>3</Id>
      <Nome>Livro 789</Nome>
      <Preco>19.90</Preco>
      </Livro>
      </ArrayOfLivro>

Se chamarmos: http://localhost:4726/api/livro/2 teremos como resposta:

Listagem 4: Resposta da chamada � Web API com par�metro para o livro

<Livro xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
      xmlns="http://schemas.datacontract.org/2004/07/WebApiTeste.Models">
      <Categoria>Drama</Categoria>
      <Id>2</Id>
      <Nome>Livro 456</Nome>
      <Preco>23.75</Preco>
      </Livro>

Da mesma forma, se chamarmos http://localhost:4726/api/livro/?categoria=Drama recebemos:

Listagem 5: Resposta da chamada � Web API com filtro para a categoria


      <ArrayOfLivro xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
      xmlns="http://schemas.datacontract.org/2004/07/WebApiTeste.Models">
      <Livro>
      <Categoria>Drama</Categoria>
      <Id>2</Id>
      <Nome>Livro 456</Nome>
      <Preco>23.75</Preco>
      </Livro>
      </ArrayOfLivro>

Ou seja, temos agora serviços sendo acessados via Browser entregando dados formatados que poder�o ser consumidos e apresentados na camada de visualizaç�o, bastanto somente chamar a URL passando o controller web API.

Pergunta:
Mas, como � resolvido que ao passar o ID = 2 na url o web API sabe que deve retornar o Livro de Id = 2? http://localhost:4726/api/livro/2

Resposta:
Graças ao Roteamento setado no arquivo Global.asax.

No m�todo Application_Start() temos o registro das rotas atrav�s da linha: RouteConfig.RegisterRoutes(RouteTable.Routes); e na classe RouteConfig temos a definiç�o das rotas, sendo que a padr�o para Asp.Net web API � a seguinte:

Listagem 6: Definiç�o de rotas

routes.MapHttpRoute(
      name: "DefaultApi",
      routeTemplate: "api//",
      defaults: new { id = RouteParameter.Optional }
      );

Ou seja, quando for recebida uma url do tipo "http://localhost:4726/api/livro/2" o web API procura um Controller com o nome passado, ou seja, no nosso caso livro.

Caso encontre, procura dentro do controller um m�todo que espera um inteiro como parametro e retorna ent�o o resultado baseado no parametro passado. O mesmo acontece para a url "http://localhost:4726/api/livro/?categoria=Drama" pois, ao encontrar no controller um m�todo esperando como par�metro uma string o mesmo retorna os dados desta categoria.

� Isso ai! Espero que tenham gostado.

Refer�ncias

REST APIs with .NET and C#

Single-page application (SPA)

The Single Page Interface Manifesto

Saiu na DevMedia!

Como criar e consumir APIs RESTful:
E se te pedirem para criar um aplicativo que combine informaç�es meteorol�gicas para que o usu�rio possa decidir onde surfar? Ou se te pedirem para implementar o pagamento por cart�o de cr�dito? Em ambos os casos voc� vai precisar de uma API, um programa criado para que programadores tenham acesso a informaç�es/serviços, a partir dos quais possam ser constru�dos novos softwares. Nesta s�rie falamos sobre como trabalhar com API.

Saiba mais sobre ASP.NET Web API ;)

O que � ASP.NET Web API?:
O ASP.NET Web API � um framework para desenvolvimento de web services RESTful sobre o .NET Framework. Com ele � poss�vel construir serviços robustos baseados no padr�o arquitetural REST, usando os recursos do protocolo HTTP, e fazendo isso com a linguagem C#.
O que � RESTful?:
ste curso possui por objetivo apresentar o que � o REST e qual a diferença entre REST e RESTful. Entenda os verbos HTTP dentro do contexto desse paradigma de programaç�o e como criar APIs que se comunicam independente da tecnologia usada para a criaç�o de cada uma delas.
Guia Completa de ASP.NET Web API:
Neste Guia de Refer�ncia voc� encontrar� o conte�do que precisa para aprender a desenvolver web services RESTful com o framework ASP.NET Web API e a linguagem C#.