• Início
• Notícias
• O que é uma API REST

02/09/2021
O que é uma API REST

Entenda tudo sobre API, HTTP e RESTful.

API é a sigla de Application Programming Interface, em português Interface de Programação de Aplicações e simplifica o desenvolvimento, pois não necessita de telas, sendo facilmente integrado aos sistemas, apenas dando respostas. Como padrão de desenvolvimento, permite a troca de APIs, e melhora a performance por causa das requisições e respostas rápidas.

Tipos de API

API Pública

É disponibilizada para qualquer um acessar, sem necessidade de autenticação;

API Privada

É quando é criada para utilização entre sistemas de uma empresa e requer autenticação;

API de Terceiros

É quando é um produto, podendo ser integrada em um sistema requerendo autenticação.

Comunicação com API

Normalmente é feita através de XML ou JSON devido a simplicidade destes tipos de dados. As requisições e respostas são feitas através do HTTP, onde podemos segui um padrão para criação de APIs robustas e que serão de fácil utilização.

Verbos do HTTP

Alterando os verbos podemos realizar requisições diferentes, simplificando a cosntrução da nossa API e seus endpoints.

GET

Resgata algum recurso;

POST

Envia dados a API;

DELETE

Remove algum registro do banco;

PUT

Atualiza o registro;

PATCH

Atualiza parcialmente do registro;

O que é endpoint

É a URL que você vai utilizar para acessar o recurso da API. Por exemplo:

/users – acesso a todos os usuários;
/users/1 – acesso ao usuário com ID 1;

E estes endpoints vem acompanhados do domínio da API, que fica algo como:

https://algumdominio.com/users

Este seria o endpoint que retorna todos os usuários, porém unido com o domínio que é convertido como DNS, servindo para acessar o nosso servidor. E dentro destes endpoints também teremos os verbos que eles aceitam, isso é tratado diretamente na aplicação. Ou seja, mudando o verbo HTTP de um endpoint podemos fazer coisas diferentes, exemplo:

GET /users/1 – retorna um usuário com id 1;
DELETE /users/1 – remove o usuário com id 1;
PATH /users/1 – atualiza usuário com id 1;

Isso é muito comum em APIs, e ajuda também a reduzir a complexidade de quem desenvolve e de quem consome os recursos.

O que é REST

Padrão/conceito de arquitetura ligado a APIs e o protocolo HTTP, podendo implementar o padrão composto de 6 partes para tornar API RESTful: 

• Uniformidade: todas as requisições para o mesmo endpoint, devem receber a mesma resposta, independente de onde vieram;
• Desacoplação: A API deve ser independente de um client, não pode interagir com a aplicação, apenas retornar respostas, baseadas na requisição;
• Stateless: as requisições não tem state, ou seja, cada uma é única e essa responsabilidade de sessão é dada a aplicação que a consulta;
• Cache: Quando possível as respostas devem ser cacheadas, melhorando a performance;
• Arquitetura de camadas: A arquitetura da API pode ser composta por camadas, fazendo com que um componente não possa acessar um superior, sem passar pelo intermediário;
• Code on demand (opicional): Em alguns casos pode haver código que precisa ser executado para rodar (Java applets), nestes casos o código deve rodar por demanda;

O que é o Postman

Software que permite testar as APIs que criamos. https://www.postman.com/