Developer Experience
5
min de leitura
28 de julho de 2020

Boas práticas: APIs e seus métodos

Luciana Bandeira
Developer Experience
Ajudo desenvolvedores no onboarding e nas melhores práticas de APIs para garantir a melhor Developer Experience. No meu tempo livre me dedico a livros, pesquisar (e degustar) sobremesas e sou apaixonada por viajar.
Mais sobre o autor

Como você já deve saber, uma API é uma comunicação simplificada e direta entre o desenvolvedor e sua empresa, segura e fácil de usar. Os métodos de uso do API podem cobrir formas de pagamento, marketplaces, benefícios, comunicação e tráfego entre sistemas internos e vários outros. Sua abordagem é essencialmente baseada no seguinte exemplo ilustrado:

OK... Mas o que dizer? Já falamos sobre algumas boas práticas no uso de APIs que abordam até mesmo bons usos e entendimento entre o desenvolvedor e suas APIs, tais como a importância do uso correto do HTTP Status (entre vários inputs e informações que você encontrará em nosso blog), e hoje falaremos sobre métodos de APIs. Embora seja um assunto muito claro para todos que já conhecem e utilizam as APIs, as pessoas que são mais leigas no assunto (mas que ainda querem saber e aprender como utilizá-las) podem acabar tendo um pouco de dúvida sobre esta questão.

As operações seguem os padrões do protocolo HTTP para processamento de chamadas e definem a ação esperada para cada um dos métodos de uso do API.

Métodos de uso de API:

  • Get (Data query/search)

Este método permite que informações/dados sejam pesquisados de acordo com o recurso e o ponto final inseridos. Você também pode (e deve) usar este método em conjunto com filtros de recursos e paging. Através deste método, o backend retornará as informações consultadas.

  • Post (Data sending/loading)

Criar/executar uma carga de novas informações para a base. É necessário enviar as informações no padrão JSON exigido no órgão de solicitação.

  • Put and Patch (Atualização de dados)

É usado para atualizar ou editar as informações já existentes na base. Algumas APIs contemplam ou não o uso do Patch (indicado para atualizações parciais), e o uso do Put é amplamente conhecido e o responsável por alterar/atualizar as informações existentes.

  • Delete (Excluir dados)

Como o nome indica, é o método responsável pela eliminação das informações. Este é um ponto importante que só é incluído dentro da API se, para a regra comercial, for necessária uma exclusão de informações da base (e se ela for permitida). Algumas empresas não permitem este uso, pois é uma ação que apagará definitivamente o registro em particular. Então, o que você achou dos métodos de uso do API? Você já os conhecia?

Obrigado pela leitura!