O que é a API REST?

• Glossário do IAM
• O que é a API REST?

Uma API REST (interface de programação de aplicativo de transferência de estado representacional), também conhecida como API RESTful, é uma interface de programação de aplicativos (API) baseada em web muito usada para desenvolver serviços de web e aplicativos móveis.

O que é uma API?

Antes de mergulharmos nos detalhes das APIs RESTful, precisamos primeiro entender o que é uma API.

Uma API é um conjunto de protocolos e rotinas que permite que diversos sistemas e aplicativos se comuniquem sem os desenvolvedores ou usuários finais saberem como foram implementados. Avaliando as APIs, os desenvolevdores podem facil e rapidamente reutilizar aplicativos de software e web.

Existem vários tipos de APIs que servem diversos casos de uso. APIs REST são amplamente usadas para desenvovler APIs baseadas em web e são uma parte importante do desenvolvimento de web moderno.

O que é REST?

REST significa "transferência de estado representacional" (Representional State Transfer). É um estilo arquitetural para desenvovler serviços de web que fornece uma forma padronizada para diversos sistemas de computadores se comunicarem pela internet. A REST é baseada em um conjunto de princípios de design em vez de um protocolo ou uma tecnologia específica e é amplamente usada para desenvolver APIs baseadas em web.

Um dos principais recursos da REST é o uso de métodos HTTP como GET, POST, PUT e DELETE para representar diferentes operações que podem ser realizadas com recursos. Esses recursos podem ser qualquer tipo de dados ou funcionalidade exposta pelo serviço de web e, geralmente, são representados usando um formato de dados padronizado, como JSON.

Uma API REST não tem estado, o que significa que cada pedido do cliente contém todas as informações necessárias para concluir o pedido e que o servidor não armazena nenhum contexto do cliente entre os pedidos. Isto torna as APIs REST flexíveis, dimensionáveis e fáceis de armazenar em cache.

Como funcionam as APIs RESTful

Como todas as outras APIs, as APIs RESTful funcionam fornecendo uma forma padronizada para diversos sistemas de computador se comunicarem pela internet. Especificamente, as APIs REST expõem recursos que aplicativos e serviços terceirizados podem acessar e manipular usando métodos HTTP padrão. Estes recursos podem ser qualquer tipo de dado ou funcionalidade que a API fornece, como dados de usuários, informações de produto ou resultados de pesquisa.

Para acessar um recurso em uma API RESTful, um cliente envia um pedido de HTTP para um ponto final específico, que é um URL que identifica o recurso. Normalmente, o pedido inclui informações adicionais, como parâmetros, cabeçalhos e um corpo de mensagem, dependendo do tipo do pedido.

O servidor processa o pedido e, se o pedido for bem-sucedido, ele envia uma resposta HTTP de volta para o cliente. Esta resposta inclui um código de status, que indica se o pedido foi bem-sucedido ou não, e um corpo de mensagem, contendo o recurso do pedido em um formato padronizado.

Como as APIs REST não têm estado, o servidor não mantém registro do estado do cliente entre os pedidos. Cada pedido de cliente contém todas as informações necessárias para gerar uma resposta.

Benefícios de APIs REST

Existem diversos benefícios para usar APIs RESTful ao desenvolver serviços de web e aplicativos direcionados por dados.

Dimensionável: As APIs RESTful são projetadas para serem dimensionáveis, o que significa que elas são capazes de lidar com grandes números de pedidos e acomodar picos de tráfego. Elas usam uma arquitetura leve e simples que facilita a adição de novos recursos e funcionalidades sem a necessidade de rearquitetar todo o sistema.

Flexível: As APIs RESTful são flexíveis e podem ser usadas com uma ampla variedade de idiomas e tecnologias de programação. Elas não estão vinculadas a plataformas ou idiomas específicos, o que significa que podem ser usadas por clientes com dispositivos e sistemas operacionais diferentes.

Intuitiva: As APIs RESTful são intuitivas e podem ser acessadas usando métodos HTTP padrão, tornando-as acessíveis a desenvolvedores de todos os níveis de habilidade. Elas fornecem uma forma padronizada para diversos sistemas conseguirem se comunicar, ajudando a reduzir o tempo de desenvolvimento, melhorar a produtividade e minimizar o tempo para comercialização.

Sem estado: O fato de as APIs RESTful serem sem estado significa que elas são mais confiáveis e fáceis de armazenar em cache, ajudando a reduzir a latência e melhorar o desempenho.

Segurança: As APIs RESTful podem ser obtidas usando uma variedade de técnicas, como criptografia SSL/TLS e autenticação OAuth. Isto ajuda a garantir que a API está protegida contra acesso não autorizado e que os dados dos clientes estão mantidos em segurança.

Práticas recomendadas da API REST

Confira algumas das práticas recomendadas para projetar e implementar APIs RESTful bem estruturadas e robustas que são fáceis de usar, confiáveis e seguras.

Use métodos HTTP corretamente: Use os métodos HTTP adequados (GET, POST, PUT, PATCH, DELETE etc.) para realizar diversas operações nos recursos, conforme a especificação HTTP. Por exemplo, use GET para recuperar um recurso, POST para criar um novo recurso, PUT para atualizar um recurso existente e DELETE para excluir um recurso.

Use URLs signifcativos: Use URLs de fácil leitura e entendimento que fornecem uma indicação clara do recurso sendo acessado. Evite URLs sem sentido difíceis de lembrar ou identificar.

Use JSON de acordo com o formato dos dados: Apesar de as APIs RESTful aceitarem e responderem a pedidos de API em diversos formatos de dados, JSON é o padrão moderno para enviar e receber dados de APIs. Isto acontece porque decodificar e codificar XML ou textos pode ser complicado, e algumas estruturas não suportam mais esses formatos.

Use substantivos em vez de verbos em URLs de ponto final: Em outras palavras, use https://www.examplo.com/publicações, e não https://www.examplo.com/obterPublicações ou https://www.examplo.com/criarPublicação. Isto se deve porque métodos HTTP como GET, POST, PUT, PATCH e DELETE já estão no formato de verbo. Usar substantivos indica o que o ponto final normalmente gera.

Não seja criativo com os códigos de resposta: Use códigos de resposta HTTP padrão para indicar o estado de um pedido, como 200 para sucesso, 404 para não encontrado e 500 para erros de servidor. Isto facilita o entendimento do resultado dos pedidos para os clientes poderem tomar uma atitude adequada.

Documentos, documentos e mais documentos: Forneça documentações detalhadas e claras para a sua API, incluindo informações sobre os recursos disponíveis, os formatos de dados e as operações suportadas. Isto facilita o entendimento e o uso da API pelos desenvolvedores.

Implemente controle de versão: Isto garante que as alterações à API não quebrem aplicativos existentes forçando-os a migrar para a nova versão.

Devolva os detalhes do erro no corpo de respostas: Os desenvolvedores agradecerão se a sua API devolver detalhes de erros, incluindo o campo afetado, no JSON ou no corpo de resposta. Isto ajuda muito a depurar aplicativos.

Proteja sua API: Implemente medidas de segurança como criptografia SSL/TLS, limite de taxas e controles de autenticação de cliente para garantir que os atores de ameaças não manipulem sua API ou a tirem da rede em um ataque DDoS.