Seja no desenvolvimento de um app de reservas online, de uma solução de pagamento mobile ou de um serviço de mensagens, é bem provável que a sua equipe esteja usando uma API REST. Neste artigo, explicamos o que é uma API REST e como ela funciona, além dos seus benefícios e usos.
O que é uma API REST?
API REST, API RESTful ou API web RESTful: todos esses nomes designam APIs que seguem um padrão específico, a arquitetura REST. Antes de ir adiante, vale lembrar que uma API, ou interface de programação de aplicações, é um software que permite que duas aplicações se comuniquem. Na computação, as APIs são essenciais para que diferentes aplicações funcionem em conjunto.
Para criar uma API, os desenvolvedores seguem métodos e princípios rigorosamente definidos, para que o conjunto funcione. Antes dos anos 2000, os desenvolvedores usavam o SOAP (Simple Object Access Protocol), um protocolo baseado em XML (Extensible Markup Language), complexo de coordenar e que consumia muitos recursos. Embora o SOAP ainda seja usado hoje, ele foi amplamente substituído pela API REST.
Criado em 2000 pelo cientista da computação norte-americano Roy Fielding durante a sua tese de doutorado, o REST (REpresentational State Transfer) se tornou o modelo dominante para criar APIs e um marco essencial na evolução da World Wide Web. Hoje, a grande maioria das APIs se baseia no REST, principalmente para oferecer serviços web, interativos ou mobile. Vamos ver como as APIs RESTful funcionam, quais são as suas vantagens e as suas diversas aplicações.
Como funciona uma API REST?
Na prática, a API REST funciona com base no princípio do ambiente cliente-servidor. A API RESTful recebe e transmite, de um lado, as requisições de um usuário ou de uma aplicação e, do outro, as informações devolvidas pelo servidor (aplicação ou banco de dados).
Alguns conceitos-chave ajudam a entender como uma API RESTful funciona. O cliente é a entidade que faz uma requisição. É o caso, por exemplo, de um usuário que faz uma busca em um catálogo de produtos no navegador. A API é responsável por comunicar a requisição ao servidor e devolver ao cliente as informações solicitadas. As informações que passam pela API são os recursos. O servidor processa as requisições. Neste caso, ele vai devolver a lista de produtos que correspondem aos critérios de busca.
As requisições do cliente são feitas pelo protocolo HTTP (Hypertext Transfer Protocol). Estes são os principais métodos e as tarefas que eles permitem realizar:
- GET: recuperar dados enviados pelo servidor.
- POST: enviar e publicar informações no servidor (dados de um formulário de cadastro, por exemplo).
- PUT: atualizar as informações do servidor.
- PATCH: modificar parcialmente um recurso existente.
- DELETE: excluir informações do servidor.
Há vários formatos de dados para usar uma API REST. O formato JSON (JavaScript Object Notation) é leve, fácil de entender e utilizável por muitas linguagens de programação. O XML permite gerenciar estruturas de dados complexas e é compatível com outros padrões, como o RSS. YAML e HTML são outros formatos usados com frequência para comunicar recursos.
Quais são os princípios da API REST?
Uma API REST segue os princípios REST de arquitetura de software. Esses princípios funcionam como diretriz para criar APIs flexíveis e leves, perfeitamente adequadas à transmissão de dados pela internet.
Estes são os seis princípios de arquitetura que regem uma interface REST:
- Desacoplamento entre cliente e servidor. O cliente conhece apenas o URI (Uniform Resource Identifier) do recurso a ser recuperado. O servidor interage apenas transmitindo os seus dados via HTTP.
- Interface uniforme. A arquitetura REST padroniza a forma como as informações são identificadas, gerenciadas e transmitidas, e usa hiperlinks para levar recursos adicionais ao cliente.
- Código sob demanda. O servidor pode transmitir código ao cliente para ampliar as suas funcionalidades, por exemplo, para ajudar a identificar erros em um formulário.
- Sistema em camadas. Uma API RESTful pode rodar em vários servidores organizados de forma hierárquica, para oferecer ao cliente um serviço mais estável e eficiente.
- Armazenável em cache. O servidor REST pode armazenar dados em cache para atender melhor o cliente, por exemplo, guardando as imagens de um site para servi-las novamente depois.
- Sem estado (stateless). Cada requisição do cliente é independente e processada isoladamente pelo servidor. Por isso, cada requisição precisa conter todos os elementos necessários para o seu processamento.
Quais são os benefícios de uma API REST?
Ao seguir os requisitos do framework da API REST, os desenvolvedores aproveitam as muitas vantagens da API RESTful para criar aplicações eficazes e poderosas:
- Versatilidade: não há restrições quanto à linguagem de programação, e há uma grande variedade de formatos de dados (XML, PYTHON, JSON, HTML etc.).
- Leveza: os formatos de dados leves de uma API REST a tornam ideal para aplicações mobile ou para a Internet das Coisas (IoT).
- Portabilidade: a separação entre cliente e servidor permite a troca de dados entre plataformas.
- Flexibilidade: esta API não tem as complexidades de um protocolo, já que é um estilo de arquitetura.
- Independência: os desenvolvedores podem trabalhar separadamente na parte do cliente ou do servidor.
Os benefícios da API REST se traduzem em mais produtividade e escalabilidade para as equipes de desenvolvimento. Escalar sistemas que usam API REST é mais fácil. Assim, as funcionalidades conseguem suportar melhor uma grande carga de usuários e operações.
Restrições de segurança
Criar e gerenciar uma API web RESTful tem os seus desafios. A autenticação de usuários pode ficar complexa quando usa vários métodos diferentes, como HTTP, chaves de API ou OAuth (Open Authorization). Em aplicações grandes e complexas, a multiplicação de endpoints entre o servidor e o cliente pode prejudicar a consistência geral, assim como as atualizações que deixam pontos de contato antigos ainda ativos.
Além disso, a interface REST tem um ponto fraco: ela transmite dados potencialmente sensíveis, como identificadores, pela URL do endpoint. Protegê-la exige medidas específicas, como criptografia Transport Layer Security (TLS), um modelo robusto de autenticação de usuários e um sistema para lidar com requisições maliciosas e limitar a vazão.
Usos de uma API REST
Os desenvolvedores usam APIs com arquitetura REST para criar e manter muitos serviços. Por isso, a maioria das aplicações web e mobile usa APIs REST para acessar e compartilhar recursos e informações. Na nuvem, esse tipo de API permite conectar rapidamente os serviços de arquiteturas distribuídas e híbridas. Em grandes empresas, ele viabiliza a interoperabilidade entre os componentes dos sistemas de informação.
Atualizar os preços de um e-commerce, automatizar publicações, orquestrar clusters do Kubernetes… O escopo de uso das APIs RESTful é limitado apenas pela imaginação dos desenvolvedores e criadores de aplicações digitais.
A API REST do GitLab
O GitLab oferece um conjunto completo de ferramentas e APIs para integrar e automatizar aplicações externas. Ele inclui GraphQL, webhooks, extensões de IDE e, claro, uma API REST. A API REST do GitLab pode ser autenticada de várias formas, como por token de acesso, OAuth ou cookies de sessão. Há endpoints disponíveis para templates de Dockerfile, .gitignore, GitLab CI/CD YAML e de código aberto. Para aproveitar ao máximo todas as possibilidades no desenvolvimento das suas aplicações ágeis e cloud native, consulte a documentação completa da API REST do GitLab (em inglês).
Perguntas frequentes
O que é uma API REST?
Uma API REST é uma interface de programação de aplicações que segue o estilo de arquitetura REST (REpresentational State Transfer) e permite que duas aplicações se comuniquem pela internet de forma leve e escalável.
Como funciona uma API REST?
Uma API REST opera em um modelo cliente-servidor, em que o cliente envia requisições HTTP a um servidor, e o servidor processa essas requisições e devolve os dados ou recursos correspondentes. Os métodos HTTP mais comuns são GET, POST, PUT, PATCH e DELETE.
Quais são os seis princípios de uma API REST?
Uma API REST segue os seis princípios principais da arquitetura REST: interface uniforme, código sob demanda, sistema em camadas, armazenável em cache, sem estado e desacoplamento entre cliente e servidor. Este último princípio é a base da estrutura de uma API RESTful e é essencial para o sucesso dessa API no mundo das aplicações web.
Quais formatos de dados uma API REST aceita?
As APIs REST aceitam vários formatos de dados, entre eles JSON, XML, YAML e HTML. O JSON é o mais usado, graças à sua estrutura leve e à compatibilidade com muitas linguagens de programação.
Quais são os benefícios de usar uma API REST?
As APIs REST oferecem versatilidade, formatos de dados leves, portabilidade, flexibilidade e independência entre o desenvolvimento do cliente e o do servidor. Essas vantagens se traduzem em mais produtividade e em escalabilidade mais fácil para as equipes de desenvolvimento.
Quais são os cuidados de segurança com uma API REST?
As APIs REST podem expor dados sensíveis pelas URLs dos endpoints. Por isso, protegê-las exige medidas como criptografia Transport Layer Security (TLS), um modelo de autenticação robusto e sistemas para lidar com requisições maliciosas e limitar a vazão.
Qual é a diferença entre REST e SOAP?
O REST é um estilo de arquitetura leve e flexível, que aceita vários formatos de dados, enquanto o SOAP é um protocolo mais antigo e mais rígido, disponível apenas em XML. O SOAP ainda pode ser usado em aplicações que exigem um alto nível de segurança.
O GitLab oferece uma API REST?
Sim, o GitLab oferece uma API REST como parte do seu conjunto de ferramentas de integração e automação. Ela aceita autenticação por tokens de acesso, OAuth e cookies de sessão, com endpoints disponíveis para templates de Dockerfile, .gitignore, GitLab CI/CD YAML e de código aberto.
Saiba mais
- Documentação da API REST do GitLab (em inglês)
- Extend with GitLab (em inglês)


