API resources do Laravel, criando repostas RESTfull

Desenvolvimento, PHP

Laravel API Resources
Laravel API Resources

Olá Pessoal, estou de volta depois de algum tempo. No último artigo eu aprofundei um pouco nos comandos do Eloquent. Tinha planejado para mostrar um pouco sobre os Controllers mas, estudando a documentação do Laravel 5.6 encontrei uma parte interessante para quem está montando API restfull para os seus webservices.  São as API resources. 

As API resources apareceram na documentação do Laravel a partir da versão 5.5. Elas funcionam como um camada de tratamento entre o Eloquent e as respostas JSON que são expostas pela API. Estas classes permitem que transformemos facilmente, models e collections em JSON.

Não é que este conceito seja completamente novo. O próprio Laravel, em versões anteriores, permite a utilização de transformers, com o Fractal, para fazer este tipo de trabalho. Mas, ao que parece, não é mais necessário instalar o módulo fractal para termos este funcionamento.

Criando um Resource

A classe resource é extremamente simples. Ela estende a classe JsonResource e implementa a função toArray(). Dentro desta função basta colocarmos os campos que queremos retornar na API e depois chamar a classe em sua controller ou rota.

Vamos ao nosso exemplo prático então… No começo desta série eu criei a tabela product, onde eu cadastrei meus produtos certo? (Confira todos os posts no fim deste artigo) Então para eu transformar o resource desta tabela basta eu criar a classe através do artisan:

Sua classe ficará como esta

Agora é só adicionar as colunas que você quer retornar pela API Resource.

Parece simples até demais neh. Mas é assim mesmo que funciona. Para finalizar precisamos chamá-la em nossa rota ou Controller. Para isto basta chamá-la estaticamente.

Neste exemplo coloquei dentro da própria rota. Mas, caso você queira fazer mais algum processo após receber seu novo JSON aconselho que mande isto para uma função na respectiva Controller. Assim, seu código ficará mais organizado.

Criando uma API Resource Collections

A classe Resource trabalha com um único model e o transforma em Array. A collection, por sua vez, trabalha com toda a coleção de dados da model. Mas não se espante, para utilizá-la é bem simples. Ao invés de instanciar o ProductResource, basta chamar o metodo collection estaticamente na rota ou controller.

Agora se quiser personalizar o retorno da Collection com alguns meta datas diferentes você pode criar uma classe separada para trabalhar em cima do Resource.

Concluindo

O Laravel nasceu com sua natureza e objetivos voltados para o paradigma do REST. A API Resources são a prova de como a comunidade Laravel está trabalhando para trazer formas otimizadas e simples no trabalho com APIs. Neste artigo apenas pincelei conceitos básicos da utilização desta funcionalidade, mas acredito que eu vá me aprofundar mais neste assunto. Espero que tenham gostado e até a próxima.

Compartilhe

Última atualização: 12 de setembro de 2018