Programação / PHP

Como construir o seu primeiro EndPoint para que outras aplicações possam consumir seus dados

Para a criação de uma API, alguns pontos devem ser levados em consideração como segurança, tratamento, padronização e baixo acoplamento.

Por Gustavo Web

Publicado por Gustavo Web
em 24/04/2018 às 09h37

Lista VIP UpInside

Entre para nossa lista VIP e receba vídeo aulas, artigos e tutoriais exclusivos e com prioridade

  QUERO ENTRAR

Aula exclusiva UpInside Play

Acessar aula no Play

Compartilhe:

Salve salve moquerido, Gustavo Web aqui!

Atendendo mais um pedido do play, essa semana vamos ver o passo a passo para criar nosso primeiro endpoint para que possamos internacionalizar nossas informações.

Quando você tem um endpoint funcionando, você pode disponibilizar as informações do seu banco de dados passando pela regra de negócio da sua aplicação, filtrar o que pode ou não ser entregue... Você ganha uma grande mobilidade com suas informações e tem a possibilidade de se integrar com outros sistemas ou até mesmo aplicativos mobile.

Repositório

Para acessar o repositório do nosso projeto, é só clicar aqui!

Antes que você se assuste, eu estou usando o composer sim... Mas não faço o uso de nenhum dependência, simplesmente trabalho com o autoload :)

Caso você não queira trabalhar com o composer, não há problema nenhum! Basta efetuar o require do arquivo manualmente sem problemas!

Você vai notar que temos duas pastinhas dentro do github, uma _initial e outra _full. A initial contém os arquivos do início da nossa aula com todos os arquivos necessários, e o Full contém o protótipo pronto com tudo já desenvolvido caso você precise consultar.

E já que você vai estar no GitHub, dá um Follow no perfil da Up, no meu, no do Rob e marca com estrelinha esse repo :)

Primeira API

Como esse foi o nosso primeiro protótipo, ele é bem primitivo! Não temos interação com o banco de dados, mas caso você queira, basta instanciar os objetos que queira trabalhar e fazer o uso normalmente... Inclusive se você tiver uma classe de Modelo da sua entidade você pode usar sem problema nenhum.

Durante a aula a gente força alguns vetores lá somente para demonstração!

Debug

Para facilitar nossa vida também, eu sugiro que você faça a instalação do Postman... O Robson já abordou ele em outras aulas de como consumir API (na aula do Active Campaing você consegue ver mais) e ele ajuda bastante!

Já corrige o problema de acentuação, tem uma interface bastante intuitiva e diversas opções para trabalhar com esse tipo de requisição.

Isso sem contar que guarda o histórico das requisições já feitas, você consegue montar uma "biblioteca" de requisições já feitas... Bem bacana o App!

Adicionais

Você viu aqui, que acabamos criando um arquivo para cada finalidade! Na minha opinião isso facilita um pouco o trabalho tendo em vista que você sabe exatamente o que está acontecendo dentro daquele endpoint...

Mas você pode preferir criar um front-controller para isso e manter tudo dentro de um único arquivo simplesmente verificando o caminho informado!

Fica seu critério escolher! Não há o certo ou errado... Você deve analisar isso de acordo com a necessidade do seu projeto :)

Outro ponto também é que você consegue notar que as primeiras linhas de cada um dos endpoint's são repetidas... Você pode desacoplar ainda mais, se sentir necessidade! 

Feedbacks

Como sempre, se tiver alguma dúvida, você pode usar os comentários aqui abaixo e eu vou responder cada um deles... Me conta o que você achou dessa aula :)

Compartilhe:

Em Programação:

Deixe seu comentário: