O que é HATEOAS? \| TreinaWeb Promoção no ar Matricule-se agora e garanta **54% de desconto** Termina em Tempo restante da oferta: 06 Horas 39 Min 01 Seg Tempo restante da oferta: 06 39 01 [Assinar →](https://www.treinaweb.com.br/checkout/pagamento/plano/anual?cupom=TW-SCLIENTE26) [ ](https://www.treinaweb.com.br) Explorar [ Quanto custa? ](#assinatura) [ FAQ ](https://www.treinaweb.com.br#faq) [Matricule-se](#assinatura) [ Entrar ](https://www.treinaweb.com.br/login) [ Início ](https://www.treinaweb.com.br) [ Artigos ](https://www.treinaweb.com.br/blog) O que é HATEOAS? [ Desenvolvimento ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento) # O que é HATEOAS? HATEOAS é um componente que faz parte da arquitetura REST, cujo objetivo é ajudar os clientes a consumirem uma API sem a necessidade de conhecimento prévio. [ Wladimilson M. Nascimento ](https://www.treinaweb.com.br/blog/autor/wladimilson-m-nascimento) 6 anos atrás ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/06/o-que-e-hateoas.png) HATEOAS é uma restrição que faz parte da arquitetura de aplicações REST, cujo objetivo é ajudar os clientes a consumirem o serviço sem a necessidade de conhecimento prévio profundo da [API](https://www.treinaweb.com.br/blog/o-que-e-uma-api/). O acrônimo HATEOAS vem de *Hypermedia As the Engine Of Application State* e o termo “hypermedia” no seu nome já dá uma ideia de como este componente funciona em uma aplicação RESTful. Ao ser implementado, a API passa a fornecer links que indicarão aos clientes como navegar através dos seus recursos. Com isso, o cliente não precisa ter um conhecimento profundo da API, basta conhecer a URL de inicial e partir dos links fornecidos poderá acessar todos os recursos de forma circular, se guiando através das requisições realizadas. Um exemplo clássico para explicar o HATEOAS, é o Hypertext, do HTML. Quando se necessita obter uma informação de um site, como um curso aqui da Treinaweb, o usuário pode acessar a página inicial (treinaweb.com.br), nela clicar em Cursos e depois no curso desejado. No fim, o usuário terá acessado uma URL como [treinaweb.com.br/curso/java-fundamentos-de-jax-ws-e-jax-rs](https://www.treinaweb.com.br/curso/java-fundamentos-de-jax-ws-e-jax-rs), onde conseguirá visualizar o curso. Não foi necessário que o usuário soubesse de antemão a URL desejada, pois é importante que o site, através de links, guie-o e auxilie-o na busca do recurso desejado. Com o HATEOAS uma API REST segue o mesmo padrão. ## Um exemplo simples do HATEOAS Por exemplo, ao acessar uma API de cursos, na URL api.treinaweb.com.br/cursos, o cliente terá o seguinte resultado: ```json { "cursos": [ { "id": 1, "nome": "C# (C Sharp)", "aulas": [ { "id": 1, "titulo": "Título da aula 3" }, { "id": 2, "titulo": "Título da aula 3" }, { "id": 3, "titulo": "Título da aula 3" }, ] }, { "id": 2, "nome": "PHP", "aulas": [ { "id": 1, "titulo": "Título da aula 3" }, { "id": 2, "titulo": "Título da aula 3" }, { "id": 3, "titulo": "Título da aula 3" }, ] }, { "id": 3, "nome": "Java", "aulas": [ { "id": 1, "titulo": "Título da aula 3" }, { "id": 2, "titulo": "Título da aula 3" }, { "id": 3, "titulo": "Título da aula 3" }, ] }, ] } ``` Se esta API implementasse o padrão HATEOAS, a resposta obtida poderia ser outra. No lugar de listar as aulas, cada curso teria um recurso próprio que retornaria suas aulas. Evitando assim que elas fiquem expostas do corpo da requisição. Algo como o exemplo abaixo: ```json { "cursos": [ { "id": 1, "nome": "C# (C Sharp)", "aulas": "api.treinaweb.com.br/cursos/1/aulas" }, { "id": 2, "nome": "PHP", "aulas": "api.treinaweb.com.br/cursos/2/aulas" }, { "id": 3, "nome": "Java", "aulas": "api.treinaweb.com.br/cursos/3/aulas" }, ] } ``` Desta forma, se o cliente desejasse obter as aulas do curso de PHP, em seguida acessaria a URL api.treinaweb.com.br/cursos/2/aulas. Note que nem é necessário montar a URL, a API já fornece o caminho correto completo. [ ![PHP - Orientação a Objetos - Parte 1](https://d2knvm16wkt3ia.cloudfront.net/assets/svg-icon/php.svg) Curso PHP - Orientação a Objetos - Parte 1 Conhecer o curso ](https://www.treinaweb.com.br/curso/php-orientacao-a-objetos-parte-1) ## Especificação do HATEOAS No exemplo anterior, o HATEOAS foi exemplificado como uma URL na resposta da API, entretanto, na prática, recomenda-se que a implementação da HATEOAS siga um dos padrões abaixo: ### RFC 5988 A especificação [RFC 5988](https://tools.ietf.org/html/rfc5988) da IETF define como links devem ser implementados. De acordo com ela, cada link deve ter as informações: - **URI:** Cada link deve conter uma URI, representada no atributo `href`; - **Tipo de relação:** Descreve como a URI se relaciona com o recurso atual, representado pelo atributo `rel`, devidado de *relationship*; - **Atributos para URI**: Para descrever melhor a URI podem ser adicionados atributos como: `hreflang`, `media`, `title` e `type`. ### JSON Hypermedia API Language (HAL) [JSON HAL](https://tools.ietf.org/html/rfc5988) é uma especificação, proposta por [Mike Kelly](http://stateless.co/hal_specification.html), ainda não aprovada, mas já comumente utilizada, que define dois MIME Types: ``` application/hal+xml application/hal+json ``` Que ao serem enviados na solicitação, a API REST deve retornar uma propriedade links, contendo as informações: - **URI**: A URI do recurso, representada pelo atributo `href`; - **Tipo de relação:** Descreve como a URI se relaciona com o recurso atual, representado pelo atributo `rel`; - **Tipo:** Descreve o tipo de conteúdo obtido ou do tipo de verbo que deve ser utilizado para acessar a URI. Representado pelo atributo **type**. Desta forma, na prática, uma API REST que implemente HATEOAS retornar uma resposta como a abaixo: ```json { "cursos": [ { "id": 1, "nome": "C# (C Sharp)", "links": [ { "type": "GET", "rel": "self", "uri": "api.treinaweb.com.br/cursos/1" }, { "type": "GET", "rel": "curso_aulas", "uri": "api.treinaweb.com.br/cursos/1/aulas" }, { "type": "PUT", "rel": "curso_atualizacao", "uri": "api.treinaweb.com.br/cursos/1" }, { "type": "DELETE", "rel": "curso_exclusao", "uri": "api.treinaweb.com.br/cursos/1" } ] }, { "id": 2, "nome": "PHP", "links": [ { "type": "GET", "rel": "self", "uri": "api.treinaweb.com.br/cursos/2" }, { "type": "GET", "rel": "curso_aulas", "uri": "api.treinaweb.com.br/cursos/2/aulas" }, { "type": "PUT", "rel": "curso_atualizacao", "uri": "api.treinaweb.com.br/cursos/2" }, { "type": "DELETE", "rel": "curso_exclusao", "uri": "api.treinaweb.com.br/cursos/2" } ] }, { "id": 3, "nome": "Java", "links": [ { "type": "GET", "rel": "self", "uri": "api.treinaweb.com.br/cursos/3" }, { "type": "GET", "rel": "curso_aulas", "uri": "api.treinaweb.com.br/cursos/3/aulas" }, { "type": "PUT", "rel": "curso_atualizacao", "uri": "api.treinaweb.com.br/cursos/3" }, { "type": "DELETE", "rel": "curso_exclusao", "uri": "api.treinaweb.com.br/cursos/3" } ] } ] } ``` ## Vantagens do HATEOAS Uma das principais vantagens do HATEOAS é permitir representar o estado de um recurso ou as limitações de um usuário sem a necessidade da implementação de outras lógicas no cliente. Por exemplo, imagine uma API de um banco. Ao consultar o saldo do usuário, caso este tenha saldo em conta, pode ser retornado os seguintes dados: ```json { "conta": { "numero": 1234, "saldo": 5120.09, "links": [ { "type": "GET", "rel": "self", "uri": "api.banco.com.br/usuario/1/conta/1234" }, { "type": "PUT", "rel": "conta_saque", "uri": "api.banco.com.br/usuario/1/conta/1234/saque" }, { "type": "PUT", "rel": "conta_deposito", "uri": "api.banco.com.br/usuario/1/conta/1234/deposito" } ] } } ``` Caso não tenha saldo, o resultado pode mudar para: ```json { "conta": { "numero": 1234, "saldo": -20.14, "links": [ { "type": "GET", "rel": "self", "uri": "api.banco.com.br/usuario/1/conta/1234" }, { "type": "PUT", "rel": "conta_deposito", "uri": "api.banco.com.br/usuario/1/conta/1234/deposito" } ] } } ``` Desta forma, o cliente não precisa se preocupar com o estado do usuário. Ele saberá que os ações disponíveis serão as retornadas no atributo `links`. Outra vantagem é a prevenção do chamado “hardcoding”, quando informações são inseridas diretamente no código da aplicação. Em todos os nossos exemplos vimos que o cliente precisa conhecer apenas a URL base da API, pois esta já irá retornar as demais URLs disponíveis. Por este comportamento que o HATEOAS geralmente é aplicado em aplicações de proposito mais geral, que são criadas para sobreviverem por um longo período. Onde alterações na API não irão impactar muito nos clientes. [ ![C# (C Sharp) - APIs REST com ASP.NET Web API](https://d2knvm16wkt3ia.cloudfront.net/assets/svg-icon/csharp.svg) Curso C# (C Sharp) - APIs REST com ASP.NET Web API Conhecer o curso ](https://www.treinaweb.com.br/curso/c-sharp-apis-rest-com-asp-net-web-api) ## Conclusão De acordo com [o modelo de maturidade de Richardson](http://martinfowler.com/articles/richardsonMaturityModel.html), o HATEOAS é considerado o último nível de uma API RESTful. Desta forma, caso esteja procurando definir uma API que siga o padrão RESTful, o HATEOAS deve ser implementado nela. Mas mesmo que não esteja seguindo o padrão RESTful a risca, é fato que o componente HATEOAS facilita e muito a manutenção de uma API e a sua integração com outras aplicações. Então, sempre que possível procure implementá-la nas APIs que desenvolver. - [ #API ](https://www.treinaweb.com.br/blog/tag/api) - [ #API REST ](https://www.treinaweb.com.br/blog/tag/api-rest) - [ #HATEOAS ](https://www.treinaweb.com.br/blog/tag/hateoas) Autor ![Wladimilson M. Nascimento](//secure.gravatar.com/avatar/f0dd442f156a3eacd2880e9cd0eafbd1?d=mm) ## Wladimilson M. Nascimento Instrutor, nerd, cinéfilo e desenvolvedor nas horas vagas. Graduado em Ciências da Computação pela Universidade Metodista de São Paulo. [Todos os artigos](https://www.treinaweb.com.br/blog/autor/wladimilson-m-nascimento) ## Continue estudando Transforme leitura em prática com os cursos e formações da TreinaWeb. [Ver cursos](https://www.treinaweb.com.br/cursos) Continue lendo ## Artigos relacionados - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/07/aplicando-hateoas-em-uma-api-jax-rs-400x280.png) [ Java ](https://www.treinaweb.com.br/blog/categoria/java) 6 anos atrás ## [ Aplicando HATEOAS em uma API JAX-RS ](https://www.treinaweb.com.br/blog/aplicando-hateoas-em-uma-api-jax-rs) Veja como implementar o HATEOAS em uma aplicação JAX-RS-Jersey de forma simples com os recursos fornecidos por esta especificação. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2024/04/sistemas-mensageria-min-400x280.png) [ Arquitetura de Software ](https://www.treinaweb.com.br/blog/categoria/arquitetura-de-software) 3 anos atrás ## [ O que é e quais as diferenças entre Kafka, RabbitMQ e AWSSQS ](https://www.treinaweb.com.br/blog/o-que-e-e-quais-as-diferencas-entre-kafka-rabbitmq-e-awssqs) Confira nesse artigo o que são sistemas de mensageria, o que são e quais as diferenças entre Kafka, RabbitMQ e AWSSQS. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2023/12/TS-ZOD-400x280.jpg) [ Javascript ](https://www.treinaweb.com.br/blog/categoria/javascript) 3 anos atrás ## [ O que é o Zod? ](https://www.treinaweb.com.br/blog/o-que-e-o-zod) Neste artigo vamos ter uma introdução sobre o Zod, uma biblioteca de declaração e validação de dados em TypeScript e criar um exemplo de como utilizá-la. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2023/11/Clean-Architecture-400x280.png) [ Arquitetura de Software ](https://www.treinaweb.com.br/blog/categoria/arquitetura-de-software) 3 anos atrás ## [ O que vem a ser a Clean Architecture? ](https://www.treinaweb.com.br/blog/o-que-vem-a-ser-a-clean-architecture) Confira nesse artigo uma introdução do que é a Clean Architecture, quais seus componentes e os benefícios ao utilizar essa arquitetura. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2023/08/code-review-400x280.png) [ Engenharia de Software ](https://www.treinaweb.com.br/blog/categoria/engenharia-de-software) 3 anos atrás ## [ O que é code review e quais são os benefícios? ](https://www.treinaweb.com.br/blog/o-que-e-code-review-e-quais-sao-os-beneficios) Confira neste artigo o que vem a ser o code review e quais são os benefícios de colocar isso em prática no seu time. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2023/05/closure-400x280.jpg) [ Desenvolvimento ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento) 4 anos atrás ## [ O que é Closure ](https://www.treinaweb.com.br/blog/o-que-e-closure) Neste artigo, veremos o que é Closure e por que é tão importante entendê-lo para saber o que acontece por debaixo dos panos na linguagem. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2023/02/CSS-JS-400x280.jpg) [ CSS ](https://www.treinaweb.com.br/blog/categoria/css) 4 anos atrás ## [ O que é PostCSS e suas funcionalidades ](https://www.treinaweb.com.br/blog/o-que-e-postcss-e-suas-funcionalidades) Neste artigo veremos uma ferramenta que vem auxiliando muito os desenvolvedores durante seus projetos, sendo ela, PostCSS. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2022/12/BFF-400x280.jpg) [ Arquitetura de Software ](https://www.treinaweb.com.br/blog/categoria/arquitetura-de-software) 4 anos atrás ## [ O que é BFF? ](https://www.treinaweb.com.br/blog/o-que-e-bff) Conheça neste artigo o pattern arquitetural BFF (Backend For Frontend). Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2022/11/O-QUE-E-HTML-400x280.jpg) [ Desenvolvimento Front-end ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento-front-end) 4 anos atrás ## [ O que é HTML? ](https://www.treinaweb.com.br/blog/o-que-e-html) No artigo de hoje, será abordado o tema HTML, nele irá conter desde sua história, quem o criou e como deve ser montada sua estrutura. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2022/10/o-que-e-e-como-comecar-com-golang-400x280.jpg) [ Desenvolvimento Back-end ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento-back-end) 4 anos atrás ## [ O que é e como começar com Go (Golang)? ](https://www.treinaweb.com.br/blog/o-que-e-e-como-comecar-com-golang) Neste artigo vamos ter o contato inicial com a linguagem Go (Golag) e aprender um pouco sobre as suas características e como funciona a sua sintaxe. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2022/09/EVENT-STORMING-400x280.jpg) [ Arquitetura de Software ](https://www.treinaweb.com.br/blog/categoria/arquitetura-de-software) 4 anos atrás ## [ O que é o Event Storming? ](https://www.treinaweb.com.br/blog/o-que-e-o-event-storming) Em situações complexas, pode ser complicado enxergar as fronteiras entre domínios, subdomínios e bounded contexts. Para auxiliar nessa missão, existe uma técnica que pode ser utilizada: trata-se do Event Storming. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2022/09/TAILWIND-CSS-400x280.jpg) [ Desenvolvimento Front-end ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento-front-end) 4 anos atrás ## [ O que é Tailwind CSS e como instalar via CDN? ](https://www.treinaweb.com.br/blog/o-que-e-tailwind-css-e-como-instalar-via-cdn) Neste artigo aprenderemos a criar um navbar usando Tailwind CSS, e entender melhor como funciona seus componentes de estilização. Ler artigo ## Um ano de acesso total para você viver de programação. Todos os cursos e formações da TreinaWeb numa única assinatura, com professores que atuam no mercado, suporte direto e certificados. Do primeiro `console.log` ao mercado de trabalho. - **1 ano** de acesso a **todos os cursos** - Cursos novos **toda semana** - Suporte **direto com professores** - Plano de carreira **personalizado** - **Certificados digitais** inclusos - **Aplicativos** para Android e iOS, com **acesso offline** **Garantia incondicional de satisfação** Teste por 7 dias e, se não fizer sentido para você, devolvemos seu dinheiro. ### Acesso completo a todos os cursos e dezenas de Formações. 12 meses Economize R$ 840,00 54% OFF de 12x R$ 129,00 por apenas 12x R$ 59,00 sem juros no cartão de crédito ou R$ 599,00 à vista Oferta termina em **06h 39min 01s** - Acesso imediato e ilimitado durante 1 ano. - Plano de carreira personalizado. - Suporte direto com professores. - E muito mais! [Matricule-se agora](https://www.treinaweb.com.br/checkout/pagamento/plano/anual?cupom=TW-SCLIENTE26) [ ](https://www.treinaweb.com.br) Escola online de programação, tecnologia e IA. - [ ](https://www.facebook.com/TreinaWeb/) - [ ](https://www.instagram.com/treinaweb/) - [ ](https://www.youtube.com/user/TreinaWeb) - [ ](https://twitter.com/treinaweb) - [ ](https://www.linkedin.com/company/treinaweb) - [ ](https://github.com/treinaweb) ## Inscreva-se em nossa newsletter Receba lançamentos, promoções e novidades. Seu nome Seu WhatsApp Seu melhor e-mail Inscrever-se ## Cursos - [ Base para Devs ](https://www.treinaweb.com.br/categoria/base-para-devs) - [ Front-end ](https://www.treinaweb.com.br/categoria/desenvolvimento-front-end) - [ Back-end ](https://www.treinaweb.com.br/categoria/desenvolvimento-back-end) - [ Mobile ](https://www.treinaweb.com.br/categoria/desenvolvimento-mobile) - [ Bancos de Dados ](https://www.treinaweb.com.br/categoria/bancos-de-dados) - [ Cloud ](https://www.treinaweb.com.br/categoria/cloud-computing) - [ IA ](https://www.treinaweb.com.br/categoria/ia) - [ E mais ](https://www.treinaweb.com.br/categoria/e-mais) - [ Ver todos os cursos ](https://www.treinaweb.com.br/cursos) ## Conteúdo - [ Formações ](https://www.treinaweb.com.br/formacoes) - [ Projetos práticos ](https://www.treinaweb.com.br/projetos-praticos) - [ Direto ao ponto ](https://www.treinaweb.com.br/direto-ao-ponto) - [ Planos ](https://www.treinaweb.com.br#assinatura) - [ Depoimentos ](https://www.treinaweb.com.br#depoimentos) - [ Comunidade ](https://www.treinaweb.com.br#comunidade) - [ Corpo docente ](https://www.treinaweb.com.br#docente) ## A empresa - [ Sobre a TreinaWeb ](https://www.treinaweb.com.br#sobre) - [ Perguntas frequentes ](https://www.treinaweb.com.br#faq) - [ Vantagens de estudar na TreinaWeb ](https://www.treinaweb.com.br/vantagens-de-estudar-na-treinaweb) - [ Cursos para empresas ](https://www.treinaweb.com.br/empresas) - [ Sugira um novo curso ](https://www.treinaweb.com.br/sugerir-curso) - [ Trabalhe conosco ](https://www.treinaweb.com.br/trabalhe-conosco) - [ Artigos ](https://www.treinaweb.com.br/blog) - [ Desenvolvedores e agentes ](https://www.treinaweb.com.br/developers) - [ Contato ](https://www.treinaweb.com.br/contato) - [ Política de privacidade ](https://www.treinaweb.com.br/politica-de-privacidade) - [ Termos de uso ](https://www.treinaweb.com.br/termos-de-uso) ## Baixe nosso aplicativo [ Disponível na **App Store** ](https://apps.apple.com/us/app/treinaweb/id1322729447) [ Disponível no **Google Play** ](https://play.google.com/store/apps/details?id=br.com.treinaweb.mobile) Av. Paulista, 1765, Conj 71 e 72 · Bela Vista · São Paulo · SP · 01311-200 © 2004 – 2026 TreinaWeb Tecnologia LTDA · CNPJ 06.156.637/0001-58