Padrões REST

Olá, querida(o) estudante! No artigo de hoje vamos estudar sobre REST (Representational State Transfer), que é uma abordagem arquitetônica essencial para o desenvolvimento de serviços web. Essa metodologia se destaca pela simplicidade e eficiência na comunicação entre cliente e servidor, oferecendo uma alternativa flexível e escalável em comparação com abordagens mais complexas como o SOAP. Este artigo explora os princípios, implementações e melhores práticas dos padrões REST.

Origens e Definição de REST:

O conceito de REST foi introduzido por Roy Fielding em sua tese de doutorado em 2000. Ele concebeu REST como um conjunto de princípios que definem como os recursos na Web devem ser formatados e transmitidos. Um exemplo emblemático de aplicação desses princípios é a API do Amazon S3, que usa REST para permitir que os desenvolvedores armazenem e recuperem qualquer quantidade de dados a qualquer momento, de qualquer lugar na Web.

Estado e Recursos:

Na arquitetura REST, o servidor é sem estado, ou seja, não armazena informações sobre as requisições dos clientes, que são independentes entre si. Cada requisição deve conter todas as informações necessárias para sua execução. Os recursos são entidades identificáveis e manipuláveis por URIs, como por exemplo, em um serviço de gerenciamento de tarefas, onde cada tarefa pode ser acessada por uma URI específica como /tasks/{task_id}. Esta abordagem promove uma interação eficiente e escalável entre cliente e servidor.

Uso de Métodos HTTP:

Os métodos HTTP são fundamentais para a operação de APIs REST, proporcionando ações padronizadas que podem ser aplicadas aos recursos da web. Cada um dos métodos define uma operação distinta, sendo os mais comuns: GET, POST, PUT, DELETE e PATCH.

• GET: É usado para recuperar dados de um servidor. Por exemplo, ao acessar uma API de previsão do tempo, um GET /weather/today retornaria os dados climáticos atuais sem afetar os dados existentes.
• POST: Utilizado para criar um novo recurso no servidor. Em um sistema de gerenciamento de conteúdo, um POST /articles com dados de artigo criaria um novo artigo.
• PUT: Serve para atualizar um recurso existente ou criar um novo se ele não existir. Se um usuário quiser atualizar um artigo, uma requisição PUT /articles/{id} com os dados atualizados seria adequada.
• DELETE: É usado para remover um recurso do servidor. Um DELETE /articles/{id} removeria o artigo especificado pelo ID.
• PATCH: Diferente do PUT, PATCH é usado para aplicar atualizações parciais a um recurso. Por exemplo, se um usuário quiser atualizar apenas o título de um artigo, uma requisição PATCH a /articles/{id} com o novo título seria o método correto.

Formatos de Representação de Dados:

Em uma API RESTful, a representação de dados é flexível, permitindo que diferentes formatos sejam usados conforme as necessidades dos consumidores da API. Os mais comuns são JSON e XML. JSON, por sua facilidade de uso com JavaScript e sua leveza, é frequentemente preferido para aplicativos web e móveis. XML, embora mais verboso, é útil em sistemas que exigem validação de documento rigorosa. 

Ambos os formatos são intercambiáveis e uma API REST bem projetada pode oferecer suporte a ambos, usando o cabeçalho Accept em uma requisição HTTP para escolher o formato desejado. Por exemplo, a API do Twitter pode retornar dados em JSON por padrão, mas também pode fornecer feeds RSS em XML se solicitado pelo cliente.

Autenticação e Segurança:

A autenticação via token é crucial nas APIs RESTful para garantir que apenas usuários autorizados acessem recursos específicos. Tokens de acesso, como os gerados pelo protocolo OAuth2, verificam a identidade do usuário e autorizam operações seguras, sendo incorporados nos cabeçalhos HTTP para reforçar a segurança nas comunicações com o servidor. Por exemplo, no Spotify, JSON Web Tokens (JWT) são utilizados para controlar o acesso às playlists dos usuários, onde cada requisição valida o JWT para assegurar que apenas usuários autenticados realizem alterações.

Tratamento de Erros:

O tratamento de erros é crucial no desenvolvimento de APIs RESTful para informar aos clientes sobre o sucesso ou falha de requisições. Utilizar códigos de status HTTP apropriados ajuda a esclarecer o tipo de erro ocorrido. Códigos 4xx indicam problemas no lado do cliente, como 400 Bad Request para requisições malformadas, enquanto códigos 5xx refletem erros no servidor, como 500 Internal Server Error. Além dos códigos, mensagens de erro detalhadas devem ser fornecidas, contendo informações úteis para diagnóstico e correção dos problemas, aumentando assim a usabilidade e confiabilidade da API.

Versionamento de API:

O versionamento de API é crucial para gerenciar mudanças e evoluções em interfaces de programação sem afetar os aplicativos existentes. As estratégias comuns incluem versionamento via URI, onde a versão é parte do caminho da URL (ex.: /v1/posts), via cabeçalhos HTTP, que mantém as URLs limpas e facilita transições suaves entre versões, e via parâmetros de consulta, que são fáceis de implementar mas podem complicar o cache. A escolha do método de versionamento deve alinhar-se às necessidades específicas do projeto e considerar a facilidade de uso para os desenvolvedores, além de planejar mudanças para minimizar interrupções e manter a consistência para os usuários.

Comparação com SOAP:

REST e SOAP são duas abordagens distintas para o desenvolvimento de serviços web. SOAP, um protocolo rigorosamente definido com base em XML, é conhecido por sua formalidade e a capacidade de operar sobre qualquer protocolo de transporte, como HTTP, SMTP, TCP, entre outros. Ele suporta recursos avançados como segurança, transações e mensagens com acordos de qualidade de serviço. Por outro lado, REST é um estilo arquitetônico que usa HTTP ou HTTPS para todas as comunicações, tornando-o mais simples e eficaz para a integração básica da web. 

REST pode usar vários formatos como JSON, XML ou até mesmo texto simples, oferecendo maior flexibilidade e eficiência no desenvolvimento de APIs web. Enquanto SOAP é ideal para operações complexas e necessidades de negócios robustas, REST é preferido para casos de uso mais comuns e interações baseadas na web devido à sua fácil implementabilidade e eficiência no desempenho.

Conclusão

À medida que a internet se torna cada vez mais interconectada e interativa, a arquitetura REST continua a se adaptar e evoluir para atender às demandas crescentes de aplicações web modernas. Novas tecnologias como GraphQL emergem para oferecer alternativas que complementam o REST, proporcionando flexibilidade adicional na manipulação e recuperação de dados. Com sua capacidade de se adaptar e integrar com novas abordagens, o REST reafirma seu papel como uma tecnologia essencial na estrutura das comunicações web, garantindo sua relevância e eficácia no desenvolvimento de interfaces de programação de aplicativos robustas e escaláveis.

Referências

• Fielding, Roy Thomas. “Architectural Styles and the Design of Network-based Software Architectures.” Diss. University of California, Irvine, 2000.
• Richardson, Leonard, e Sam Ruby. “RESTful Web Services.” O’Reilly Media, Inc., 2007.
• Webber, Jim, Savas Parastatidis, e Ian Robinson. “REST in Practice: Hypermedia and Systems Architecture.” O’Reilly Media, Inc., 2010.
• Allamaraju, Subbu. “RESTful Web Services Cookbook: Solutions for Improving Scalability and Simplicity.” O’Reilly Media, Inc., 2010.
• Tilkov, Stefan, e Cesare Pautasso. “REST: From Research to Practice.” Springer, 2011.

Vamos ver como esse assunto é cobrado em concursos!

1) Ano: 2023 Banca: FUNDATEC Órgão: PROCERGS Prova: FUNDATEC – 2023 – PROCERGS – ANC – Analista em Computação – Ênfase em Programação de Sistemas na Tecnologia Microsoft

É uma vantagem da utilização de REST API em aplicações .NET: 

a)Só pode ser utilizada para aplicações web e mobile.

b)É uma arquitetura que só pode ser utilizada com a linguagem C#.

c)Permite que as aplicações se comuniquem de forma mais eficiente do que as APIs tradicionais.

d)É uma arquitetura mais complexa e difícil de ser implementada do que as APIs tradicionais.

e)É uma arquitetura mais flexível e escalável, permitindo que as aplicações possam ser facilmente integradas com outras plataformas e serviços.

Gabarito: E

Comentário: REST é uma arquitetura flexível e escalável, permitindo que as aplicações sejam facilmente integradas com outras plataformas e serviços. Esta é uma das vantagens mais significativas do REST, pois não está atrelado a linguagens de programação específicas e pode ser utilizado em uma variedade de contextos, incluindo, mas não se limitando a, aplicações web e mobile. As alternativas A e B estão incorretas, pois REST não é limitado apenas a aplicações web e mobile e pode ser usado com várias linguagens de programação, não apenas C#. A alternativa C menciona comunicação eficiente, o que é verdade, mas essa afirmação é menos específica do que a flexibilidade e escalabilidade mencionadas na alternativa E. A alternativa D é incorreta porque REST geralmente é considerado menos complexo e mais fácil de implementar do que outras arquiteturas de API, como o SOAP. Portanto, a alternativa E é a resposta mais apropriada e completa para a pergunta.

2) Ano: 2022 Banca: CESPE / CEBRASPE Órgão: TCE-RJ Prova: CESPE / CEBRASPE – 2022 – TCE-RJ – Analista de Controle Externo

Julgue o item subsequente, a respeito dos padrões XML, XSLT, SOAP, REST e JSON.

A linguagem XSLT é utilizada para converter um documento XML em uma página HTML ou em outro documento XML. 

( ) Certo

( ) Errado

Gabarito: Certo

Comentário: A linguagem XSLT (eXtensible Stylesheet Language Transformations) é especificamente utilizada para transformar documentos XML em outros formatos, incluindo, mas não limitado a, HTML e outros documentos XML. Isso é alcançado através da definição de regras de transformação em uma folha de estilo XSLT, que é processada por um motor XSLT em conjunto com o documento XML de entrada para produzir o documento de saída desejado.

3) Ano: 2020 Banca: CESPE / CEBRASPE Órgão: TJ-PA Prova: CESPE – 2020 – TJ-PA – Analista Judiciário – Programador

No que tange ao uso de serviços da API REST, a arquitetura JWT é um modelo utilizado para 

a)conectar a uma fonte de dados remota.

b)autenticar e validar o acesso ao serviço através de um token.

c)realizar envio de dados através de arquivos JSON.

d)fazer autenticação através de um usuário e senha.

e)sincronizar as informações entre cliente e servidor.

4) Ano: 2022 Banca: FUNDEP (Gestão de Concursos) Órgão: UFJF Prova: FUNDEP (Gestão de Concursos) – 2022 – UFJF – Técnico de Tecnologia da Informação – Edital nº 70

Numere a COLUNA II de acordo com a COLUNA I, associando os métodos de request às ações em que melhor se encaixam considerando um serviço REST.

COLUNA I
1. GET 
2. POST 
3. PUT 
4. DELETE

COLUNA II
(   ) Criar um novo usuário 
(   ) Excluir um usuário 
(   ) Listar usuários cadastrados 
(   ) Editar dados do usuário 

Assinale a sequência correta. 

a)3 4 1 2

b)3 4 2 1

c)2 4 1 3

d)2 3 1 4

e)2 4 3 1

Gabarito: C

Comentário: 

Para associar corretamente os métodos de requisição HTTP de um serviço REST com as ações dadas, seguiríamos a seguinte lógica:

• POST: Este método é comumente usado para criar um novo recurso na representação do servidor, então seria usado para “Criar um novo usuário”.
• DELETE: Este método é utilizado para excluir um recurso, portanto seria usado para “Excluir um usuário”.
• GET: É usado para consultar e recuperar informações, neste caso, “Listar usuários cadastrados”.
• PUT: É utilizado para atualizar um recurso existente em sua totalidade, então se encaixaria em “Editar dados do usuário”.

Assim, a sequência correta de associação seria:

(2) POST – Criar um novo usuário

(4) DELETE – Excluir um usuário

(1) GET – Listar usuários cadastrados

(3) PUT – Editar dados do usuário

Então é isso! 

Bons estudos e até o nosso próximo artigo.

Prof. Ana Júlia B. de Souza