Nancy Framework: Serviços HTTP em .NET

O framework NancyFx é uma das ferramentas de desenvolvimento web que mais vem ganhando popularidade nos últimos anos entre os desenvolvedores da linguagem C#. Este framework teve boa parte do seu código desenvolvida com base no Sinatra, uma biblioteca para aplicações web escrita em Ruby como alternativa a frameworks como Ruby on Rails e Merb. Dessa forma, o Nancy tem em sua base um projeto maduro e a experiência de desenvolvimento e melhorias que se mostraram necessárias com o tempo.

Nancy é um framework bastante leve para a criação de serviços HTTP em baseados em .NET, ele abstrai toda a complexidade de configuração de ambiente e a partir de uma linguagem com convenções baseadas nos métodos do protocolo HTTP, permite o desenvolvimento de serviços em pouco tempo. O Nancy foi desenvolvido para trabalhar com as requisições HTTP do tipo GET, DELETE, PUT, POST, PATCH, HEAD e OPTIONS e provê uma linguagem específica de domínio simples e elegante para retornar uma determinada resposta com apenas um conjunto de palavras chaves. Esse framework é, ainda, open source e está disponível no GitHub.

O Nancy foi desenvolvido para funcionar em qualquer lugar, o que quer dizer que ele não tem dependências com relação a outros frameworks, além de ser completamente autocontido com seus próprios objetos de solicitação e respostas.

Um dos conceitos fundamentais desse framework é o de Hosts, que atuam como adaptadores para o ambiente de hospedagem e permitem que o Nancy seja executado em praticamente qualquer tipo de aplicação, como ASP.NET, WCF e Owin. Mais adiante neste artigo utilizaremos esses componentes na prática, juntamente com os modules.

Em conjunto com práticas importantes e bastante aconselhadas no desenvolvimento de software, como testes unitários com NUnit e mocking (BOX 1) com a biblioteca Moq, desenvolveremos neste artigo um serviço HTTP utilizando Nancy em conjunto com ASP.NET, persistindo dados no SQL Server 2014 com o Fluent NHibernate.

Utilizando os modules no NancyFx

O ponto chave de seu funcionamento do Nancy são os módulos onde definimos o comportamento das aplicações. Para adicionarmos um módulo à aplicação devemos criar uma classe herdando de NancyModule, isso nos permitirá utilizar rotas e ações que devem executar as suas chamadas. Além disso, os módulos também nos permitem acessar informações completas sobre a requisição, acessar contextos nos quais as solicitações estão sendo processadas e usar helpers para a construção de tipos específicos de respostas, como o JSON.

Em uma aplicação Nancy podemos ter quantos módulos forem necessários, devendo haver pelo menos um módulo e uma rota definida para o seu funcionamento. Essa característica do módulo de definir um caminho nos permite criar um namespace para todas as rotas necessárias definidas no módulo, de forma que cada uma dessas rotas será subordinada ao caminho que estiver presente no módulo. Dessa forma, evitamos a necessidade de ficar repetindo trechos de rota comuns à aplicação, como podemos ver no exemplo da Listagem 1.

01. public class ModuloTesteProduto : NancyModule
02. {
03.     public ModuloTesteProduto() : base("/vendas")
04.     {
05.         // aqui teríamos a rota para /vendas/listaItens sendo enviada via GET[]
06.         Get["/listaItens"] = parameters => {
07.             return "Lista de produtos de uma venda..";
08.         };
09.     }
10. }

Definição das rotas

Rotas são padrões de URL que fazem com que uma requisição HTTP seja direcionada para um método que irá trata-la da forma mais adequada. Para que possamos definir uma rota com o Nancy, é necessário que estas sejam definidas no construtor do método, onde precisamos especificar, pelo menos, os 3 parâmetros que são obrigatórios para o seu perfeito funcionamento: “method”, o “pattern” e a “Action”. Além deles, de forma opcional, podemos passar também uma condição (parâmetro “condition”), como podemos observar na Listagem 2.

01. public class ModuloTesteProduto : NancyModule
02. {
03.     public ModuloTesteProduto()
04.     {
05.         Get["/vendas/{id}"] = _ =>
06.         {
07.             //Dentro desse espaço é onde definimos a nossa condição para retornar os dados 
                //baseado no identificador do pedido.
08.         };
09.     }
10. }

Nessa listagem definimos uma rota que será acessada em chamadas pelo método HTTP GET, que é o método padrão utilizado para obtenção de recursos em um serviço. O parâmetro id pode ser obtido no corpo do método a partir do objeto anônimo gerado ao utilizar a expressão lambda. De forma equivalente, poderíamos definir rotas para outros métodos HTTP, como Post[...] ou Put[...], de acordo com a função de cada um na aplicação.

O que podemos entender das Actions

Actions são métodos executados quando uma determinada requisição corresponde a uma rota específica e são representadas por uma expressão lambda do tipo Func, onde temos uma entrada de informações de forma dinâmica do tipo DynamicDictionary, um tipo especial definido no Nancy. Quanto ao retorno deseta Action, este pode ser qualquer classe do domínio da aplicação, adequado à solicitação recebida. Por exemplo, podemos retornar um objeto da classe Produto cujo ID seja igual ao valor recebido na URL quando a rota /GetProduto/{id} for acessada, da seguinte forma:

Get["/GetProduto/{id}"] = parameters => {
  return db.Produtos.FirstOrDefault(p => p.ID == parameters.id);
};

Aqui utilizamos o parâmetro recebido na URL através do objeto parameters utilizado na expressão lambda para definir o resultado da action. É ...